RouteInfo Class Reference

RouteInfo class is used during retrieving informations about computed route by ApiNavigation#getRouteInfo(boolean,int). More...

Classes
class	RouteInfoTime
	Helper class for getting date and time data from RouteInfo#getEstimatedTimeArrival() function. More...

Public Member Functions
	RouteInfo ()
	Class constructor. More...
	RouteInfo (int bottom, int left, int right, int top, int estimatedTimeArrival, int remainingDistance, int remainingTime, int status, int totalDistance, int totalTime, int[] timeToWp, int[] distToWp)
int	getTotalDistance ()
int	getRemainingDistance ()
Rectangle	getBoundaryRectangle ()
	Notes: BrowseMap is map shown on after clicking Browse Map menu button. More...
int	getStatus ()
	Notes: Possible values are: More...
int	getRemainingTime ()
int	getTotalTime ()
int[]	getTimeToWp ()
int[]	getDistanceToWp ()
RouteInfoTime	getEstimatedTimeArrival ()
	Returns class which contains estimated time of arrival. More...
String	toString ()

Static Public Member Functions
static Bundle	writeBundle (RouteInfo info)
static RouteInfo	readBundle (Bundle b)

Detailed Description

RouteInfo class is used during retrieving informations about computed route by ApiNavigation#getRouteInfo(boolean,int).

Constructor & Destructor Documentation

RouteInfo

(

)

Class constructor.

Referenced by RouteInfo.readBundle().

RouteInfo	(	int	bottom,
		int	left,
		int	right,
		int	top,
		int	estimatedTimeArrival,
		int	remainingDistance,
		int	remainingTime,
		int	status,
		int	totalDistance,
		int	totalTime,
		int[]	timeToWp,
		int[]	distToWp
	)

Member Function Documentation

Rectangle getBoundaryRectangle

(

)

Notes:
BrowseMap is map shown on after clicking Browse Map menu button.

BrowseMap allows browse the loaded maps and change zoom.

Returns

Rectangle class defining rectangle on BrowseMap in which route is situated.

Referenced by RouteInfo.writeBundle().

int [] getDistanceToWp

(

)

Returns

the array of distance values to each waypoint

Referenced by RouteInfo.writeBundle().

RouteInfoTime getEstimatedTimeArrival

(

)

Returns class which contains estimated time of arrival.

Use class methods to obtain values.

Returns

Estimated time of arrival.

Referenced by RouteInfo.toString().

int getRemainingDistance

(

)

Returns

Distance from actual position to finish of the route in meters.

Referenced by RouteInfo.writeBundle().

int getRemainingTime

(

)

Returns

Remaining time.

Referenced by RouteInfo.writeBundle().

int getStatus

(

)

Notes:
Possible values are:

• 0 None.
• 1 Computing.
• 2 Computed.

Returns

State of the route.

Referenced by RouteInfo.writeBundle().

int [] getTimeToWp

(

)

Returns

the array of time values to each waypoint

Referenced by RouteInfo.writeBundle().

int getTotalDistance

(

)

Returns

Total distance of route in meters.

Referenced by RouteInfo.writeBundle().

int getTotalTime

(

)

Returns

Total time.

Referenced by RouteInfo.writeBundle().

static RouteInfo readBundle ( Bundle  b )

static

References RouteInfo.RouteInfo().

Referenced by ApiNavigation.getRouteInfo().

String toString

(

)

References RouteInfo.getEstimatedTimeArrival(), and RouteInfo.RouteInfoTime.toString().

static Bundle writeBundle ( RouteInfo  info )

static

References RouteInfo.getBoundaryRectangle(), RouteInfo.getDistanceToWp(), RouteInfo.getRemainingDistance(), RouteInfo.getRemainingTime(), RouteInfo.getStatus(), RouteInfo.getTimeToWp(), RouteInfo.getTotalDistance(), RouteInfo.getTotalTime(), and Rectangle.toArray().