Packagecom.mapquest
Classpublic class RouteOptions
InheritanceRouteOptions Inheritance MQObject

Options used when calculating routes.

See also

RouteType
AutoRouteCovSwitch
IntCollection
DistanceUnits
NarrativeType
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
  
RouteOptions()
RouteOptions
  
getAutoRouteCovSwitch():AutoRouteCovSwitch
Returns the m_AutoRouteCovSwitch object.
RouteOptions
  
getAvoidAbsGefIdList():IntCollection
Returns the m_AvoidAbsGefIdList collection.
RouteOptions
  
getAvoidAttrList():StringCollection
Returns the m_AvoidAttrList collection.
RouteOptions
  
getAvoidGefIdList():IntCollection
Returns the m_AvoidGefIdList collection.
RouteOptions
  
getClassName():String
Returns the text name of this class.
RouteOptions
  
getCountryBoundaryDisplay():Boolean
Gets the country boundary display flag
RouteOptions
  
getCoverageName():String
Returns the coverage name of the routing data to use takes precedence over CovSwitcher.
RouteOptions
  
getDistanceUnits():DistanceUnits
Returns the m_DistanceUnits object.
RouteOptions
  
getLanguage():String
Returns the language set for this RouteOptions object.
RouteOptions
  
getMaxGEFIDsPerManeuver():Number
Returns the maximum number of GEFIDs for the route options.
RouteOptions
  
getMaxShapePointsPerManeuver():Number
Returns the maximum number of shape points for the route options.
RouteOptions
  
getNarrativeType():NarrativeType
Returns the m_NarrativeType object.
RouteOptions
  
getObjectVersion():Number
Returns the version of this class.
RouteOptions
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getRouteType():RouteType
Returns the m_RouteType object.
RouteOptions
  
getStateBoundaryDisplay():Boolean
Gets the state boundary display flag
RouteOptions
 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.
RouteOptions
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build xml that represents this object.
RouteOptions
  
setAutoRouteCovSwitch(autoRouteCovSwitch:AutoRouteCovSwitch):void
Sets the m_AutoRouteCovSwitch collection.
RouteOptions
  
setAvoidAbsGefIdList(avoidAbsGefIdList:IntCollection):void
Sets the m_AvoidAbsGefIdList collection.
RouteOptions
  
setAvoidAttrList(avoidAttrList:StringCollection):void
Sets the m_AvoidAttrList collection.
RouteOptions
  
setAvoidGefIdList(avoidGefIdList:IntCollection):void
Sets the m_AvoidGefIdList collection.
RouteOptions
  
setCountryBoundaryDisplay(bFlag:Boolean):void
Sets the country boundary display flag.
RouteOptions
  
setCoverageName(newCoverageName:String):void
Set the coverage name of the routing data to use takes precedence over CovSwitcher.
RouteOptions
  
setDistanceUnits(distanceUnits:DistanceUnits):void
Sets the m_DistanceUnits collection.
RouteOptions
  
setLanguage(strLanguage:String):void
Sets the language for the server to use on a route narrative.
RouteOptions
  
setMaxGEFIDsPerManeuver(nCount:int):void
Sets the maximum number of GEFIDs for the server to return from the route.
RouteOptions
  
setMaxShapePointsPerManeuver(nCount:int):void
Sets the maximum number of shape points for the server to return from the route.
RouteOptions
  
setNarrativeType(narrativeType:NarrativeType):void
Sets the m_NarrativeType collection.
RouteOptions
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setRouteType(routeType:RouteType):void
Sets the m_RouteType collection.
RouteOptions
  
setStateBoundaryDisplay(bFlag:Boolean):void
Sets the state boundary display flag.
RouteOptions
 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
RouteOptions()constructor
public function RouteOptions()
Method detail
getAutoRouteCovSwitch()method
public function getAutoRouteCovSwitch():AutoRouteCovSwitch

Returns the m_AutoRouteCovSwitch object.

Returns
AutoRouteCovSwitch — The m_AutoRouteCovSwitch object.
getAvoidAbsGefIdList()method 
public function getAvoidAbsGefIdList():IntCollection

Returns the m_AvoidAbsGefIdList collection.

Returns
IntCollection — The m_AvoidAbsGefIdList collection.
getAvoidAttrList()method 
public function getAvoidAttrList():StringCollection

Returns the m_AvoidAttrList collection.

Returns
StringCollection — The m_AvoidAttrList collection.
getAvoidGefIdList()method 
public function getAvoidGefIdList():IntCollection

Returns the m_AvoidGefIdList collection.

Returns
IntCollection — The m_AvoidGefIdList collection.
getClassName()method 
public override function getClassName():String

Returns the text name of this class.

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

Gets the country boundary display flag

Returns
Boolean — true if a country boundary text should be displayed, false otherwise.
getCoverageName()method 
public function getCoverageName():String

Returns the coverage name of the routing data to use takes precedence over CovSwitcher.

Returns
String — The coverage name
getDistanceUnits()method 
public function getDistanceUnits():DistanceUnits

Returns the m_DistanceUnits object.

Returns
DistanceUnits — The m_DistanceUnits object.
getLanguage()method 
public function getLanguage():String

Returns the language set for this RouteOptions object.

Returns
String — The language set
getMaxGEFIDsPerManeuver()method 
public function getMaxGEFIDsPerManeuver():Number

Returns the maximum number of GEFIDs for the route options.

Returns
Number — The maximum number of GEFIDs
getMaxShapePointsPerManeuver()method 
public function getMaxShapePointsPerManeuver():Number

Returns the maximum number of shape points for the route options.

Returns
Number — The maximum number of shape points
getNarrativeType()method 
public function getNarrativeType():NarrativeType

Returns the m_NarrativeType object.

Returns
NarrativeType — The m_NarrativeType object.
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
getRouteType()method 
public function getRouteType():RouteType

Returns the m_RouteType object.

Returns
RouteType — The m_RouteType object.
getStateBoundaryDisplay()method 
public function getStateBoundaryDisplay():Boolean

Gets the state boundary display flag

Returns
Boolean — true if a state boundary text should be displayed, false otherwise.
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.
setAutoRouteCovSwitch()method 
public function setAutoRouteCovSwitch(autoRouteCovSwitch:AutoRouteCovSwitch):void

Sets the m_AutoRouteCovSwitch collection.

Parameters
autoRouteCovSwitch:AutoRouteCovSwitch — autoRouteCovSwitch The object to set m_AutoRouteCovSwitch to.
setAvoidAbsGefIdList()method 
public function setAvoidAbsGefIdList(avoidAbsGefIdList:IntCollection):void

Sets the m_AvoidAbsGefIdList collection.

Parameters
avoidAbsGefIdList:IntCollection — AvoidAbsGefIdList The collection to set m_AvoidAbsGefIdList to.
setAvoidAttrList()method 
public function setAvoidAttrList(avoidAttrList:StringCollection):void

Sets the m_AvoidAttrList collection.

Parameters
avoidAttrList:StringCollection — AvoidAttrList The collection to set m_AvoidAttrList to.
setAvoidGefIdList()method 
public function setAvoidGefIdList(avoidGefIdList:IntCollection):void

Sets the m_AvoidGefIdList collection.

Parameters
avoidGefIdList:IntCollection — AvoidGefIdList The collection to set m_AvoidGefIdList to.
setCountryBoundaryDisplay()method 
public function setCountryBoundaryDisplay(bFlag:Boolean):void

Sets the country boundary display flag.

Parameters
bFlag:Boolean — {Boolean} bFlag The country boundary display flag
setCoverageName()method 
public function setCoverageName(newCoverageName:String):void

Set the coverage name of the routing data to use takes precedence over CovSwitcher.

Parameters
newCoverageName:String — newCoverageName The coverage name
setDistanceUnits()method 
public function setDistanceUnits(distanceUnits:DistanceUnits):void

Sets the m_DistanceUnits collection.

Parameters
distanceUnits:DistanceUnits — object to set m_DistanceUnits to.
setLanguage()method 
public function setLanguage(strLanguage:String):void

Sets the language for the server to use on a route narrative. Valid values for languages are defined by the members of this class starting with the prefix szLanguage_.

Parameters
strLanguage:String — strLanguage containing a valid language
setMaxGEFIDsPerManeuver()method 
public function setMaxGEFIDsPerManeuver(nCount:int):void

Sets the maximum number of GEFIDs for the server to return from the route. The smaller the number the less data gets returned from the server response on a route.

Parameters
nCount:int — nCount with the maximum number of GEFIDs.
setMaxShapePointsPerManeuver()method 
public function setMaxShapePointsPerManeuver(nCount:int):void

Sets the maximum number of shape points for the server to return from the route. The smaller the number the less data gets returned from the server response on a route.

Parameters
nCount:int — nCount with the maximum number of shape points.
setNarrativeType()method 
public function setNarrativeType(narrativeType:NarrativeType):void

Sets the m_NarrativeType collection.

Parameters
narrativeType:NarrativeType — object to set m_NarrativeType to.
setRouteType()method 
public function setRouteType(routeType:RouteType):void

Sets the m_RouteType collection.

Parameters
routeType:RouteType — object to set m_RouteType to.
setStateBoundaryDisplay()method 
public function setStateBoundaryDisplay(bFlag:Boolean):void

Sets the state boundary display flag.

Parameters
bFlag:Boolean — bFlag The state boundary display flag