PoiCategory Class Reference

PoiCategory class specifies a POI category. More...

Public Member Functions
	PoiCategory ()
	Class constructor.
	PoiCategory (int notifDist, boolean notifOnRoad, String name, String sound)
String	getName ()
	Returns POI category name.
void	setName (String name)
	Sets POI category name.
String	getSound ()
	Returns sound file name as from the following pattern "sounds/(name).ogg".
void	setSound (String fileName)
	Sets sound file name as from the following pattern "sounds/(name).ogg".
int	getNotificationDistance ()
void	setNotificationDistance (int notificationDistance)
boolean	isNotifyOnlyWhenOnRoad ()
void	setNotifyOnlyWhenOnRoad (boolean notifyOnlyWhenOnRoad)
String	toString ()

Static Public Member Functions
static Bundle	writeBundle (PoiCategory poiCat)
static PoiCategory	readBundle (Bundle b)

Public Attributes
int	lNotificationDistance
	Notification distance for POI warning.
boolean	bNotifyOnlyWhenOnRoad
	Notify only when POI is on road.
String	strName
String	strSound

Detailed Description

PoiCategory class specifies a POI category.

It is used as a parameter for defining POI warnings in ApiPoi#setPoiWarning(PoiCategory, int) function.

Constructor & Destructor Documentation

PoiCategory() [1/2]

PoiCategory

(

)

Class constructor.

Referenced by readBundle(), and writeBundle().

PoiCategory() [2/2]

PoiCategory	(	int	notifDist,
		boolean	notifOnRoad,
		String	name,
		String	sound )

Member Function Documentation

getName()

String getName

(

)

Returns POI category name.

For default categories it is string representation of a number, for UPI(user defined POI) files it is its name.

Returns

A new string to POI category name.

Referenced by writeBundle().

getNotificationDistance()

int getNotificationDistance

(

)

Returns

Notification distance for POI warning.

References lNotificationDistance.

Referenced by writeBundle().

getSound()

String getSound

(

)

Returns sound file name as from the following pattern "sounds/(name).ogg".

Returns

A new string to sound file name as from the following pattern "sounds/(name).ogg"

Referenced by writeBundle().

isNotifyOnlyWhenOnRoad()

boolean isNotifyOnlyWhenOnRoad

(

)

Returns

Notify only when POI is on road.

References bNotifyOnlyWhenOnRoad.

Referenced by writeBundle().

readBundle()

PoiCategory readBundle ( Bundle b )

static

References PoiCategory().

Referenced by ApiPoi.getPoiCategoryList(), and ApiPoi.setPoiWarning().

setName()

void setName

(

String

name

)

Sets POI category name.

For default categories it is string representation of a number, for UPI(user defined POI) files it is its name.

Parameters

name	A string to POI category name.

setNotificationDistance()

void setNotificationDistance

(

int

notificationDistance

)

Parameters

notificationDistance

notification distance for POI warning.

setNotifyOnlyWhenOnRoad()

void setNotifyOnlyWhenOnRoad

(

boolean

notifyOnlyWhenOnRoad

)

Parameters

notifyOnlyWhenOnRoad

notify only when POI is on road.

setSound()

void setSound

(

String

fileName

)

Sets sound file name as from the following pattern "sounds/(name).ogg".

Parameters

fileName

A string to sound file name as from the following pattern "sounds/(name).ogg"

toString()

String toString

(

)

References bNotifyOnlyWhenOnRoad, lNotificationDistance, strName, and strSound.

writeBundle()

Bundle writeBundle ( PoiCategory poiCat )

static

References PoiCategory(), getName(), getNotificationDistance(), getSound(), and isNotifyOnlyWhenOnRoad().

Referenced by ApiPoi.setPoiWarning().

Member Data Documentation

bNotifyOnlyWhenOnRoad

boolean bNotifyOnlyWhenOnRoad

Notify only when POI is on road.

Referenced by isNotifyOnlyWhenOnRoad(), and toString().

lNotificationDistance

int lNotificationDistance

Notification distance for POI warning.

Referenced by getNotificationDistance(), and toString().

strName

String strName

Referenced by toString().

strSound

String strSound

Referenced by toString().