Class MQManeuver

Object
   |
   +--MQObject
         |
         +--MQManeuver

class MQManeuver

extends MQObject

This object will hold each maneuver of a trekroute returned from a route.
See:

- MQLatLngCollection
- MQSignCollection
- MQStringCollection

Field Detail

m_GEFIDs

<private> MQIntCollection m_GEFIDs

Value to represent the collection of GEFIDs

m_ShapePoints

<private> MQLatLngCollection m_ShapePoints

Value to represent the collection of shape points.

m_Signs

<private> MQSignCollection m_Signs

Value to represent the collection of signs

m_Streets

<private> MQStringCollection m_Streets

Value to represent the collection of streets.

MQManeuver

MQManeuver()

Constructs a new MQManeuver object.

See:
- MQLatLngCollection
- MQSignCollection
- MQStringCollection

getAttributes

int getAttributes()

Get the attributes associated with this maneuver.

Returns:
The attributes associated with this maneuver.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getDirection

int getDirection()

Returns an integer representing the direction for this Maneuver.

Returns:
The integer representing the direction for this Maneuver.

getDirectionName

String getDirectionName()

Returns a string representing the direction for this Maneuver.

Returns:
The string representing the direction for this Maneuver.

getDistance

Float getDistance()

Returns the distance of this Maneuver.

Returns:
The distance of this Maneuver.

getGEFIDs

MQIntCollection getGEFIDs()

Returns the m_GEFIDs collection.

Returns:
The m_GEFIDs collection.

getNarrative

String getNarrative()

Returns a string representing the narrative for this Maneuver.

Returns:
a string representing the narrative for this Maneuver

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getShapePoints

MQLatLngCollection getShapePoints()

Returns the m_ShapePoints collection.

Returns:
The m_ShapePoints collection.

getSigns

MQSignCollection getSigns()

Returns the m_Signs collection.

Returns:
The m_Signs collection.

getStreets

MQStringCollection getStreets()

Returns the m_Streets collection.

Returns:
The m_Streets collection.

getTime

int getTime()

Returns the seconds to travel this Maneuver.

Returns:
The seconds to travel this Maneuver.

getTurnType

int getTurnType()

Returns the turn type of this Maneuver.

Returns:
The turn type of this Maneuver.

loadXml

void loadXml(<String> strXml)

Assigns the xml that relates to this object.

Parameters:
strXml - the xml to be assigned.

saveXml

String saveXml()

Build an xml string that represents this object.

Returns:
The xml string.

setAttributes

void setAttributes(<int> attributes)

Set the attributes associated with this maneuver.

Parameters:
attributes - attributes associated with this maneuver.

setDirection

void setDirection(<int> direction)

Sets an integer representing the direction for this Maneuver.

Parameters:
direction - The direction for this Maneuver

setDistance

void setDistance(<Float> distance)

Sets the distance of this Maneuver.

Parameters:
distance - The distance

setGEFIDs

void setGEFIDs(<MQIntCollection> GEFIDs)

Sets the m_GEFIDs collection.

Parameters:
GEFIDs - The collection to set m_GEFIDs to.

setNarrative

void setNarrative(<String> narrative)

Sets a string representing the narrative for this Maneuver.

Parameters:
narrative - a string representing the narrative for this Maneuver

setShapePoints

void setShapePoints(<MQLatLngCollection> shapePoints)

Sets the m_ShapePoints collection.

Parameters:
shapePoints - The collection to set m_ShapePoints to.

setSigns

void setSigns(<MQSignCollection> signs)

Sets the m_Signs collection.

Parameters:
signs - The collection to set m_Signs to.

setStreets

void setStreets(<MQStringCollection> streets)

Sets the m_Streets collection.

Parameters:
streets - The collection to set m_Streets to.

setTime

void setTime(<int> seconds)

Sets the seconds to travel this Maneuver.

Parameters:
seconds - The seconds to travel this Maneuver.

setTurnType

void setTurnType(<int> type)

Sets the turn type of this Maneuver.

Parameters:
type - that is a valid turn type Valid types are the constants starting with K_