Android Java SDK for Sygic 3D
PoiOnRoute Class Reference

The class is used with the search operations on POIs on route. More...

Public Member Functions

 PoiOnRoute ()
 Class constructor. More...
 
 PoiOnRoute (int x, int y, String cat, String name, String address, int timeRemaining, int distanceRemaining)
 
String getCategory ()
 Returns POI category. More...
 
void setCategory (String cat)
 Set a string to POI category. More...
 
String getName ()
 Returns POI name which is shown in POI list. More...
 
void setName (String name)
 Sets POI name which is shown in POI list. More...
 
Position getLocation ()
 Returns POI location on map. More...
 
String getAddress ()
 Returns POI address in one string format. More...
 
void setAddress (String strAddress)
 
void setLocation (int x, int y)
 Sets POI location on map. More...
 
int getTimeRemaining ()
 Returns the time in seconds to reach the poi from the current position following the calculated route. More...
 
void setTimeRemaining (int timeRemaining)
 
int getDistanceRemaining ()
 Returns the distance in meters to reach the poi from the current position following the calculated route. More...
 
void setDistanceRemaining (int distanceRemaining)
 
String toString ()
 

Static Public Member Functions

static Bundle writeBundle (PoiOnRoute poi)
 
static PoiOnRoute readBundle (Bundle b)
 

Detailed Description

The class is used with the search operations on POIs on route.

Constructor & Destructor Documentation

◆ PoiOnRoute() [1/2]

Class constructor.

Referenced by PoiOnRoute.readBundle().

◆ PoiOnRoute() [2/2]

PoiOnRoute ( int  x,
int  y,
String  cat,
String  name,
String  address,
int  timeRemaining,
int  distanceRemaining 
)

Member Function Documentation

◆ getAddress()

String getAddress ( )

Returns POI address in one string format.

Returns
POI address.

Referenced by PoiOnRoute.writeBundle().

◆ getCategory()

String getCategory ( )

Returns POI category.

Returns
The name of POI category.

Referenced by PoiOnRoute.writeBundle().

◆ getDistanceRemaining()

int getDistanceRemaining ( )

Returns the distance in meters to reach the poi from the current position following the calculated route.

Returns
distance in meters.

Referenced by PoiOnRoute.writeBundle().

◆ getLocation()

Position getLocation ( )

Returns POI location on map.

Returns
POI location on map.

Referenced by PoiOnRoute.writeBundle().

◆ getName()

String getName ( )

Returns POI name which is shown in POI list.

Returns
POI name.

Referenced by PoiOnRoute.writeBundle().

◆ getTimeRemaining()

int getTimeRemaining ( )

Returns the time in seconds to reach the poi from the current position following the calculated route.

Returns
time in seconds.

Referenced by PoiOnRoute.writeBundle().

◆ readBundle()

static PoiOnRoute readBundle ( Bundle  b)
static

References PoiOnRoute.PoiOnRoute().

Referenced by ApiPoi.getPoiOnRoute().

◆ setAddress()

void setAddress ( String  strAddress)

◆ setCategory()

void setCategory ( String  cat)

Set a string to POI category.

Parameters
catString of POI category name.

◆ setDistanceRemaining()

void setDistanceRemaining ( int  distanceRemaining)

◆ setLocation()

void setLocation ( int  x,
int  y 
)

Sets POI location on map.

Parameters
xDetermines X coordinate (geographical longitude) of location in world degrees multiplied by 100 000.
yDetermines Y coordinate (geographical latitude) of location in world degrees multiplied by 100 000.

◆ setName()

void setName ( String  name)

Sets POI name which is shown in POI list.

Parameters
namePOI name which is shown in POI list.

◆ setTimeRemaining()

void setTimeRemaining ( int  timeRemaining)

◆ toString()

String toString ( )

◆ writeBundle()