Class MQRouteResults

Object
   |
   +--MQObject
         |
         +--MQRouteResults

class MQRouteResults

extends MQObject

Contains the results of a routing request.
See:

- MQLatLngCollection
- MQLocationCollection
- MQRouteResultsCode
- MQStringCollection
- MQTrekRouteCollection

Field Detail

distance

<private> Float distance

Value of the total distance for this maneuver.

m_Locations

<private> MQLocationCollection m_Locations

Value to represent the collection of locations.

m_ResultCode

<private> MQRouteResultsCode m_ResultCode

Value to represent the collection of locations.

m_ResultMessages

<private> MQStringCollection m_ResultMessages

Value to represent the collection of result messages.

m_TrekRoutes

<private> MQTrekRouteCollection m_TrekRoutes

Value to represent the collection of MQTrekRoutes.

shapePoints

<private> MQManeuverCollection shapePoints

Value to represent the collection of streets.

time

<private> int time

Value of the total time for this maneuver.

MQRouteResults

MQRouteResults()

Constructs a new MQRouteResults object.

See:
- MQLatLngCollection
- MQLocationCollection
- MQRouteResultsCode
- MQStringCollection
- MQTrekRouteCollection

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getCoverageName

String getCoverageName()

Gets the Coverage name used to perform this route.

Returns:
The value of CoverageName

getDistance

Float getDistance()

Returns the total distance for this maneuver.

Returns:
The total distance for this maneuver.

getLocations

MQLocationCollection getLocations()

Returns all Locations used in the route. LatLng may be altered to closest point on found road segment. Locations may be re-ordered in the case of an optimized route

Returns:
All Locations used in the route.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getResultCode

MQRouteResultsCode getResultCode()

Gets the result code member of this object.

Returns:
The result code member of this object.

getResultMessages

MQStringCollection getResultMessages()

Returns the messages returned by Server. Each result message should contain a unique number followed by a text description. Ex: "200 Unable to calculate route." Messages for invalid locations should be numbered 100..199 Messages for route failures should be numbered 200..99

Returns:
An MQStringCollection of messages.

getShapePoints

MQLatLngCollection getShapePoints()

Returns the shapePoints collection made by appending all the maneuver shape point collections.

Returns:
The shapePoints collection.

getTime

int getTime()

Returns the total time for this maneuver.

Returns:
The total time for this maneuver.

getTrekRoutes

MQTrekRouteCollection getTrekRoutes()

Returns the TrekRouteCollection member of this object.

Returns:
All TrekRoutes used in the route.

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.

setCoverageName

void setCoverageName(<String> strName)

Sets the Coverage name used to perform this route.

Parameters:
strName - Name of coverage.

setResultCode

void setResultCode(<MQRouteResultsCode> resultCode)

Sets the result code member of this object.

Parameters:
resultCode - The MQRouteResultsCode for this MQRouteResults object.