Packagecom.mapquest
Classpublic class Maneuver
InheritanceManeuver 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
  
Constructs a new Maneuver object.
Maneuver
  
Get the attributes associated with this maneuver.
Maneuver
  
getClassName():String
Returns the text name of this class.
Maneuver
  
Returns an integer representing the direction for this Maneuver.
Maneuver
  
Returns a string representing the direction for this Maneuver.
Maneuver
  
getDistance():Number
Returns the distance of this Maneuver.
Maneuver
  
Returns the m_GEFIDs collection.
Maneuver
  
getNarrative():String
Returns a string representing the narrative for this Maneuver.
Maneuver
  
Returns the version of this class.
Maneuver
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
Returns the m_ShapePoints collection.
Maneuver
  
Returns the m_Signs collection.
Maneuver
  
Returns the m_Streets collection.
Maneuver
  
getTime():int
Returns the seconds to travel this Maneuver.
Maneuver
  
Returns the turn type of this Maneuver.
Maneuver
 Inherited
Create a copy of this object.
MQObject
 Inherited
MQObject
 Inherited
MQObject
  
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
Maneuver
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build xml that represents this object.
Maneuver
  
setAttributes(attributes:int):void
Set the attributes associated with this maneuver.
Maneuver
  
setDirection(direction:int):void
Sets an integer representing the direction for this Maneuver.
Maneuver
  
setDistance(distance:Number):void
Sets the distance of this Maneuver.
Maneuver
  
setGEFIDs(GEFIDs:IntCollection):void
Sets the m_GEFIDs collection.
Maneuver
  
setNarrative(narrative:String):void
Sets a string representing the narrative for this Maneuver.
Maneuver
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setShapePoints(shapePoints:LatLngCollection):void
Sets the m_ShapePoints collection.
Maneuver
  
Sets the m_Signs collection.
Maneuver
  
Sets the m_Streets collection.
Maneuver
  
setTime(seconds:int):void
Sets the seconds to travel this Maneuver.
Maneuver
  
setTurnType(type:int):void
Sets the turn type of this Maneuver.
Maneuver
 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
Maneuver()constructor
public function Maneuver()

Constructs a new Maneuver object.

Method detail
getAttributes()method
public function getAttributes():int

Get the attributes associated with this maneuver.

Returns
int — The attributes associated with this maneuver.
getClassName()method 
public override function getClassName():String

Returns the text name of this class.

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

Returns an integer representing the direction for this Maneuver.

Returns
int — The integer representing the direction for this Maneuver.
getDirectionName()method 
public function getDirectionName():String

Returns a string representing the direction for this Maneuver.

Returns
String — The string representing the direction for this Maneuver.
getDistance()method 
public function getDistance():Number

Returns the distance of this Maneuver.

Returns
Number — The distance of this Maneuver.
getGEFIDs()method 
public function getGEFIDs():IntCollection

Returns the m_GEFIDs collection.

Returns
IntCollection — The m_GEFIDs collection.
getNarrative()method 
public function getNarrative():String

Returns a string representing the narrative for this Maneuver.

Returns
String
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 m_ShapePoints collection.

Returns
LatLngCollection — The m_ShapePoints collection.
getSigns()method 
public function getSigns():SignCollection

Returns the m_Signs collection.

Returns
SignCollection — The m_Signs collection.
getStreets()method 
public function getStreets():StringCollection

Returns the m_Streets collection.

Returns
StringCollection — The m_Streets collection.
getTime()method 
public function getTime():int

Returns the seconds to travel this Maneuver.

Returns
int — The seconds to travel this Maneuver.
getTurnType()method 
public function getTurnType():int

Returns the turn type of this Maneuver.

Returns
int — The turn type of 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.
setAttributes()method 
public function setAttributes(attributes:int):void

Set the attributes associated with this maneuver.

Parameters
attributes:int — attributes attributes associated with this maneuver.
setDirection()method 
public function setDirection(direction:int):void

Sets an integer representing the direction for this Maneuver.

Parameters
direction:int — direction The direction for this Maneuver
setDistance()method 
public function setDistance(distance:Number):void

Sets the distance of this Maneuver.

Parameters
distance:Number — distance The distance
setGEFIDs()method 
public function setGEFIDs(GEFIDs:IntCollection):void

Sets the m_GEFIDs collection.

Parameters
GEFIDs:IntCollection — The collection to set m_GEFIDs to.
setNarrative()method 
public function setNarrative(narrative:String):void

Sets a string representing the narrative for this Maneuver.

Parameters
narrative:String — narrative a string representing the narrative for this Maneuver
setShapePoints()method 
public function setShapePoints(shapePoints:LatLngCollection):void

Sets the m_ShapePoints collection.

Parameters
shapePoints:LatLngCollection — The collection to set m_ShapePoints to.
setSigns()method 
public function setSigns(signs:SignCollection):void

Sets the m_Signs collection.

Parameters
signs:SignCollection — The collection to set m_Signs to.
setStreets()method 
public function setStreets(streets:StringCollection):void

Sets the m_Streets collection.

Parameters
streets:StringCollection — streets The collection to set m_Streets to.
setTime()method 
public function setTime(seconds:int):void

Sets the seconds to travel this Maneuver.

Parameters
seconds:int — seconds The seconds to travel this Maneuver.
setTurnType()method 
public function setTurnType(type:int):void

Sets the turn type of this Maneuver.

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