Packagecom.mapquest
Classpublic class RouteResults
InheritanceRouteResults Inheritance MQObject

Contains the results of a routing request.

See also

LatLngCollection
LocationCollection
RouteResultsCode
StringCollection
TrekRouteCollection

Public Properties
 PropertyDefined by
 InheritedCLASS_NAME : String = "MQObject"
[static]
MQObject
Protected Properties
 PropertyDefined by
 InheritedobjectVersion : Number = 0
Value to represent the version of this object
MQObject
 Inheritedxml : XML = null
MQObject
 Inheritedxpath : String
MQObject
Public Methods
 MethodDefined by
  
RouteResults()
Constructs a new RouteResults object.
RouteResults
  
getBoundingBox():IRectLL
Get RectLL
RouteResults
  
getClassName():String
Returns the text name of this class.
RouteResults
  
getCoverageName():String
Gets the Coverage name used to perform this route.
RouteResults
  
getDistance():Number
Returns the total distance for this maneuver.
RouteResults
  
getLocations():LocationCollection
Returns all Locations used in the route.
RouteResults
  
getObjectVersion():Number
Returns the version of this class.
RouteResults
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getResultCode():RouteResultsCode
Gets the result code member of this object.
RouteResults
  
getResultMessages():StringCollection
Returns the messages returned by Server.
RouteResults
  
getShapePoints():LatLngCollection
Returns the shapePoints collection made by appending all the maneuver shape point collections.
RouteResults
  
getTime():int
Returns the total time for this maneuver.
RouteResults
  
getTrekRoutes():TrekRouteCollection
Returns the TrekRouteCollection member of this object.
RouteResults
 Inherited
internalCopy(obj:MQObject):MQObject
Create a copy of this object.
MQObject
 Inherited
internalCopyXML(obj:MQObject):XML
MQObject
 Inherited
internalCopyXMLx(obj:MQObject):String
MQObject
  
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
RouteResults
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build xml that represents this object.
RouteResults
  
setBoundingBox(value:RectLL):void
Set RectLL
RouteResults
  
setCoverageName(strName:String):void
Sets the Coverage name used to perform this route.
RouteResults
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setResultCode(resultCode:RouteResultsCode):void
Sets the result code member of this object.
RouteResults
 Inherited
setXpath(xpath:String):void
Sets the m_xpath object.
MQObject
 Inherited
writeExternal(output:IDataOutput):void
MQObject
Protected Methods
 MethodDefined by
 Inherited
getXML():XML
Returns the m_xmlDoc object.
MQObject
 Inherited
getXpath():String
Returns the xpath string.
MQObject
 Inherited
setXML(xml:XML):void
Sets the m_xmlDoc object.
MQObject
Constructor detail
RouteResults()constructor
public function RouteResults()

Constructs a new RouteResults object.

Method detail
getBoundingBox()method
public function getBoundingBox():IRectLL

Get RectLL

Returns
IRectLL
getClassName()method 
public override function getClassName():String

Returns the text name of this class.

Returns
String — The text name of this class.
getCoverageName()method 
public function getCoverageName():String

Gets the Coverage name used to perform this route.

Returns
String — The value of CoverageName
getDistance()method 
public function getDistance():Number

Returns the total distance for this maneuver.

Returns
Number — The total distance for this maneuver.
getLocations()method 
public function getLocations():LocationCollection

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
LocationCollection — All Locations used in the route.
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
getResultCode()method 
public function getResultCode():RouteResultsCode

Gets the result code member of this object.

Returns
RouteResultsCode — The result code member of this object.
getResultMessages()method 
public function getResultMessages():StringCollection

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
StringCollection — An StringCollection of messages.
getShapePoints()method 
public function getShapePoints():LatLngCollection

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

Returns
LatLngCollection — The shapePoints collection.
getTime()method 
public function getTime():int

Returns the total time for this maneuver.

Returns
int — The total time for this maneuver.
getTrekRoutes()method 
public function getTrekRoutes():TrekRouteCollection

Returns the TrekRouteCollection member of this object.

Returns
TrekRouteCollection — All TrekRoutes used in the route.
loadXml()method 
public override function loadXml(xmlPrm:XML):void

Assigns the xml that relates to this object.

Parameters
xmlPrm:XML — the xml to be assigned.
saveXml()method 
public override function saveXml():XML

Build xml that represents this object.

Returns
XML — The xml.
setBoundingBox()method 
public function setBoundingBox(value:RectLL):void

Set RectLL

Parameters
value:RectLL
setCoverageName()method 
public function setCoverageName(strName:String):void

Sets the Coverage name used to perform this route.

Parameters
strName:String — Name of coverage.
setResultCode()method 
public function setResultCode(resultCode:RouteResultsCode):void

Sets the result code member of this object.

Parameters
resultCode:RouteResultsCode — RouteResultsCode for this RouteResults object.