Packagecom.mapquest
Classpublic class TrekRoute
InheritanceTrekRoute Inheritance MQObject

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

See also

LatLngCollection
SignCollection
StringCollection

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
  
TrekRoute()
Constructs a new TrekRoute object.
TrekRoute
  
getClassName():String
Returns the text name of this class.
TrekRoute
  
getDistance():Number
Returns the total distance for this maneuver.
TrekRoute
  
getManeuvers():ManeuverCollection
Returns the maneuverList collection.
TrekRoute
  
getObjectVersion():Number
Returns the version of this class.
TrekRoute
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getShapePoints():LatLngCollection
Returns the shapePoints collection made by appending all the maneuver shape point collections.
TrekRoute
  
getTime():int
Returns the total time for this maneuver.
TrekRoute
 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.
TrekRoute
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build xml that represents this object.
TrekRoute
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
 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
TrekRoute()constructor
public function TrekRoute()

Constructs a new TrekRoute object.

Method detail
getClassName()method
public override function getClassName():String

Returns the text name of this class.

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

Returns the total distance for this maneuver.

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

Returns the maneuverList collection.

Returns
ManeuverCollection — The maneuverList collection.
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
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.
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.