PoiCategory class specifies a POI category. More...
Public Member Functions | |
PoiCategory () | |
Class constructor. More... | |
PoiCategory (int notifDist, boolean notifOnRoad, String name, String sound) | |
String | getName () |
Returns POI category name. More... | |
void | setName (String name) |
Sets POI category name. More... | |
String | getSound () |
Returns sound file name as from the following pattern "sounds/(name).ogg". More... | |
void | setSound (String fileName) |
Sets sound file name as from the following pattern "sounds/(name).ogg". More... | |
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. More... | |
boolean | bNotifyOnlyWhenOnRoad |
Notify only when POI is on road. More... | |
String | strName |
String | strSound |
PoiCategory class specifies a POI category.
It is used as a parameter for defining POI warnings in ApiPoi#setPoiWarning(PoiCategory, int) function.
PoiCategory | ( | ) |
Class constructor.
Referenced by PoiCategory.readBundle().
PoiCategory | ( | int | notifDist, |
boolean | notifOnRoad, | ||
String | name, | ||
String | sound | ||
) |
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.
References PoiCategory.strName.
Referenced by PoiCategory.writeBundle().
int getNotificationDistance | ( | ) |
References PoiCategory.lNotificationDistance.
Referenced by PoiCategory.writeBundle().
String getSound | ( | ) |
Returns sound file name as from the following pattern "sounds/(name).ogg".
References PoiCategory.strSound.
Referenced by PoiCategory.writeBundle().
boolean isNotifyOnlyWhenOnRoad | ( | ) |
References PoiCategory.bNotifyOnlyWhenOnRoad.
Referenced by PoiCategory.writeBundle().
|
static |
References PoiCategory.PoiCategory().
Referenced by ApiPoi.getPoiCategoryList(), and ApiPoi.setPoiWarning().
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.
name | A string to POI category name. |
void setNotificationDistance | ( | int | notificationDistance | ) |
notificationDistance | notification distance for POI warning. |
void setNotifyOnlyWhenOnRoad | ( | boolean | notifyOnlyWhenOnRoad | ) |
notifyOnlyWhenOnRoad | notify only when POI is on road. |
void setSound | ( | String | fileName | ) |
Sets sound file name as from the following pattern "sounds/(name).ogg".
fileName | A string to sound file name as from the following pattern "sounds/(name).ogg" |
String toString | ( | ) |
|
static |
References PoiCategory.getName(), PoiCategory.getNotificationDistance(), PoiCategory.getSound(), and PoiCategory.isNotifyOnlyWhenOnRoad().
Referenced by ApiPoi.setPoiWarning().
boolean bNotifyOnlyWhenOnRoad |
Notify only when POI is on road.
Referenced by PoiCategory.isNotifyOnlyWhenOnRoad(), and PoiCategory.toString().
int lNotificationDistance |
Notification distance for POI warning.
Referenced by PoiCategory.getNotificationDistance(), and PoiCategory.toString().
String strName |
Referenced by PoiCategory.getName(), and PoiCategory.toString().
String strSound |
Referenced by PoiCategory.getSound(), and PoiCategory.toString().