Android Java SDK for Sygic 3D
PoiCategory Class Reference

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
 

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]

Class constructor.

Referenced by PoiCategory.readBundle().

◆ 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.

References PoiCategory.strName.

Referenced by PoiCategory.writeBundle().

◆ getNotificationDistance()

int getNotificationDistance ( )
Returns
Notification distance for POI warning.

References PoiCategory.lNotificationDistance.

Referenced by PoiCategory.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"

References PoiCategory.strSound.

Referenced by PoiCategory.writeBundle().

◆ isNotifyOnlyWhenOnRoad()

boolean isNotifyOnlyWhenOnRoad ( )
Returns
Notify only when POI is on road.

References PoiCategory.bNotifyOnlyWhenOnRoad.

Referenced by PoiCategory.writeBundle().

◆ readBundle()

static PoiCategory readBundle ( Bundle  b)
static

◆ 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
nameA string to POI category name.

◆ setNotificationDistance()

void setNotificationDistance ( int  notificationDistance)
Parameters
notificationDistancenotification distance for POI warning.

◆ setNotifyOnlyWhenOnRoad()

void setNotifyOnlyWhenOnRoad ( boolean  notifyOnlyWhenOnRoad)
Parameters
notifyOnlyWhenOnRoadnotify only when POI is on road.

◆ setSound()

void setSound ( String  fileName)

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

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

◆ toString()

◆ writeBundle()

Member Data Documentation

◆ bNotifyOnlyWhenOnRoad

boolean bNotifyOnlyWhenOnRoad

Notify only when POI is on road.

Referenced by PoiCategory.isNotifyOnlyWhenOnRoad(), and PoiCategory.toString().

◆ lNotificationDistance

int lNotificationDistance

Notification distance for POI warning.

Referenced by PoiCategory.getNotificationDistance(), and PoiCategory.toString().

◆ strName

String strName

◆ strSound

String strSound