WayPoint Class Reference

WayPoint class specifies location of one point on map. More...

Public Member Functions
	WayPoint ()
	Class constructor.
	WayPoint (String str, int x, int y)
	Class constructor.
	WayPoint (String str, int x, int y, String customAddress)
	Class constructor.
void	SetLocation (int x, int y)
	Sets Position position of waypoint on map.
Position	getLocation ()
	Gets the location.
String	getStrAddress ()
	Gets the address.
void	setCustomAddress (String customAddress)
	Sets the custom address string.
String	getCustomAddress ()
	Gets the custom address string.
String	toString ()

Static Public Member Functions
static Bundle	writeBundle (WayPoint wp)
static WayPoint	readBundle (Bundle b)

Detailed Description

WayPoint class specifies location of one point on map.

It is used as a parameter determining target location in ApiNavigation#startNavigation(WayPoint, int, boolean, int) function.

Constructor & Destructor Documentation

WayPoint() [1/3]

WayPoint

(

)

Class constructor.

Referenced by WayPoint.readBundle().

WayPoint() [2/3]

WayPoint	(	String	str,
		int	x,
		int	y )

Class constructor.

Parameters

str	Address of waypoint.
x	Position class field which determines X coordinate (geographical longitude) of location in world degrees multiplied by 100 000.
y	Position class field which determines Y coordinate (geographical latitude) of location in world degrees multiplied by 100 000.

WayPoint() [3/3]

WayPoint	(	String	str,
		int	x,
		int	y,
		String	customAddress )

Class constructor.

Parameters

str	Address of waypoint.
x	Position class field which determines X coordinate (geographical longitude) of location in world degrees multiplied by 100 000.
y	Position class field which determines Y coordinate (geographical latitude) of location in world degrees multiplied by 100 000.
customAddress	Custom address name that will be used as a location name for waypoint Will also get voiced upon arriving in finish Maximum address name size is 255 characters, the rest will be cut off

Member Function Documentation

getCustomAddress()

String getCustomAddress

(

)

Gets the custom address string.

Returns

custom address string

Referenced by WayPoint.writeBundle().

getLocation()

Position getLocation

(

)

Gets the location.

Returns

The Location. Position class defining a position of waypoint on map.

Referenced by WayPoint.writeBundle().

getStrAddress()

String getStrAddress

(

)

Gets the address.

Returns

the address of waypoint

Referenced by WayPoint.writeBundle().

readBundle()

static WayPoint readBundle ( Bundle b )

static

References WayPoint.WayPoint().

Referenced by ApiLocation.locationFromAddressEx().

setCustomAddress()

void setCustomAddress

(

String

customAddress

)

Sets the custom address string.

Parameters

customAddress

custom address string

SetLocation()

void SetLocation	(	int	x,
		int	y )

Sets Position position of waypoint on map.

Parameters

x	Position class field which determines X coordinate (geographical longitude) of location in world degrees multiplied by 100 000.
y	Position class field which determines Y coordinate (geographical latitude) of location in world degrees multiplied by 100 000.

References Position.setPosition().

toString()

String toString

(

)

writeBundle()

static Bundle writeBundle ( WayPoint wp )

static

References WayPoint.getCustomAddress(), WayPoint.getLocation(), WayPoint.getStrAddress(), and Position.toArray().

Referenced by ApiNavigation.startNavigation().