StopOffPoint Class Reference

StopOffPoint class is used during manipulation with itinerary. More...

Classes
class	PointType

Public Member Functions
	StopOffPoint ()
	Class constructor. More...
	StopOffPoint (boolean searchAddress, boolean visited, int pointType, int x, int y, int offset, int id, String iso, String caption, String address)
	Class constructor. More...
String	getAddress ()
	Returns address of waypoint. More...
void	setAddress (String address)
String	getCaption ()
	Returns name of waypoint. More...
void	setCaption (String caption)
	Sets name of waypoint. More...
String	getIso ()
	Returns the iso code of country, where the waypoint is located. More...
void	setIso (String iso)
	Sets the iso code of country, where the waypoint is located. More...
boolean	isSearchAddress ()
void	setSearchAddress (boolean searchAddress)
boolean	isVisited ()
void	setVisited (boolean visited)
int	getPointType ()
void	setPointType (int pointType)
Position	getLocation ()
void	setLocation (Position location)
int	getOffset ()
void	setOffset (int offset)
int	getId ()
	Gets the unique id. More...
void	setId (int dwId)
	Sets the unique id. More...
String	toString ()

Static Public Member Functions
static Bundle	writeBundle (StopOffPoint sop)
static StopOffPoint	readBundle (Bundle b)

Detailed Description

StopOffPoint class is used during manipulation with itinerary.

Constructor & Destructor Documentation

StopOffPoint

(

)

Class constructor.

Referenced by StopOffPoint.readBundle().

StopOffPoint	(	boolean	searchAddress,
		boolean	visited,
		int	pointType,
		int	x,
		int	y,
		int	offset,
		int	id,
		String	iso,
		String	caption,
		String	address
	)

Class constructor.

Member Function Documentation

String getAddress

(

)

Returns address of waypoint.

Notes:

of waypoint is set only if bSearchAddress was set to true when adding waypoint.

Returns

A new string to address of waypoint.

Referenced by StopOffPoint.writeBundle().

String getCaption

(

)

Returns name of waypoint.

Notes:

of waypoint is shown in itinerary items list.

Returns

A new string to name of waypoint.

Referenced by StopOffPoint.writeBundle().

int getId

(

)

Gets the unique id.

Returns

the id

Referenced by StopOffPoint.writeBundle().

String getIso

(

)

Returns the iso code of country, where the waypoint is located.

Returns

A new string to iso code of the country.

Referenced by StopOffPoint.writeBundle().

Position getLocation

(

)

Returns

Position class defining position of waypoint on map.

Referenced by StopOffPoint.writeBundle().

int getOffset

(

)

Returns

Road offset from our map, where the waypoint is located. Use conversion table to obtain the offset from map provider segment ID.
When using offset, the ISO code has to be used.

Referenced by StopOffPoint.writeBundle().

int getPointType

(

)

Returns

Flag determining type of waypoint.

Notes:
Possible values are:

• 1 Viapoint
• 2 Finish
• 3 Start
• 4 Invisible

Referenced by StopOffPoint.writeBundle().

boolean isSearchAddress

(

)

Returns

Flag determining whether function processing instance of this class searches for address (for example when adding waypoint).

Notes:
Possible values are:

• true Search for address.
• false Do not search for address.

Referenced by StopOffPoint.writeBundle().

boolean isVisited

(

)

Returns

Flag determinig whether waypoint was already visited.

Notes:
Possible values are:

• true Waypoint was visited.
• false Waypoint was not visited.

Referenced by StopOffPoint.writeBundle().

static StopOffPoint readBundle ( Bundle  b )

static

References StopOffPoint.StopOffPoint().

Referenced by ApiItinerary.getItineraryList().

void setAddress

(

String

address

)

void setCaption

(

String

caption

)

Sets name of waypoint.

Notes:

of waypoint is shown in itinerary items list.

Parameters

caption

A string contains the name of waypoint.

void setId

(

int

dwId

)

Sets the unique id.

Parameters

dwId	the new id

void setIso

(

String

iso

)

Sets the iso code of country, where the waypoint is located.

Parameters

iso	A string to iso code of country.

void setLocation

(

Position

location

)

Parameters

location

Position class defining position of waypoint on map.

void setOffset

(

int

offset

)

Parameters

offset

Road offset from our map, where the waypoint is located. Use conversion table to obtain the offset from map provider segment ID. When using offset, the ISO code has to be used.

void setPointType

(

int

pointType

)

Parameters

pointType

Flag determining type of waypoint.

Notes:
Possible values are:

• 1 Viapoint
• 2 Finish
• 3 Start
• 4 Invisible

void setSearchAddress

(

boolean

searchAddress

)

Parameters

searchAddress

Flag determining whether function processing instance of this class searches for address (for example when adding waypoint).

Notes:
Possible values are:

• true Search for address.
• false Do not search for address.

void setVisited

(

boolean

visited

)

Parameters

visited

Flag determinig whether waypoint was already visited.

Notes:
Possible values are:

• true Waypoint was visited.
• false Waypoint was not visited.

String toString

(

)

static Bundle writeBundle ( StopOffPoint  sop )

static

References StopOffPoint.getAddress(), StopOffPoint.getCaption(), StopOffPoint.getId(), StopOffPoint.getIso(), StopOffPoint.getLocation(), StopOffPoint.getOffset(), StopOffPoint.getPointType(), StopOffPoint.isSearchAddress(), StopOffPoint.isVisited(), and Position.toArray().

Referenced by ApiItinerary.addEntryToItinerary(), and ApiItinerary.addItinerary().