Packagecom.mapquest
Classpublic class RouteMatrixResults
InheritanceRouteMatrixResults Inheritance MQObject

Contains the results of a route matrix request.

See also

RouteMatrixResultsCode
StringCollection
IntCollection

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
  
RouteMatrixResults()
Constructs a new RouteMatrixResults object.
RouteMatrixResults
  
getAllToAllFlag():Boolean
Gets the all-to-all flag.
RouteMatrixResults
  
getClassName():String
Returns the text name of this class.
RouteMatrixResults
  
getCoverageName():String
Gets the Coverage name used to perform this route.
RouteMatrixResults
  
getDistance(from:int, toPos:int):Number
Returns the calculated distance of the route.
RouteMatrixResults
  
getObjectVersion():Number
Returns the version of this class.
RouteMatrixResults
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getResultCode():RouteMatrixResultsCode
Gets the result code member of this object.
RouteMatrixResults
  
getResultsMessages():StringCollection
Gets the result messages of this object.
RouteMatrixResults
  
getTime(from:int, toPos:int):int
Returns the calculated elapsed time in seconds for the route.
RouteMatrixResults
 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.
RouteMatrixResults
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build xml that represents this object.
RouteMatrixResults
  
setCoverageName(newCoverageName:String):void
Sets the Coverage name used to perform this route.
RouteMatrixResults
  
setDistance(col:IntCollection):void
Sets the distance IntCollection.
RouteMatrixResults
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setResultCode(rc:RouteMatrixResultsCode):void
Sets the result code member of this object.
RouteMatrixResults
  
setTime(col:IntCollection):void
Sets the time IntCollection.
RouteMatrixResults
 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
RouteMatrixResults()constructor
public function RouteMatrixResults()

Constructs a new RouteMatrixResults object.

Method detail
getAllToAllFlag()method
public function getAllToAllFlag():Boolean

Gets the all-to-all flag.

Returns
Boolean — Returns the allToAll flag. True if the matrix is from each location to each other, False if from location 0 to all others.
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(from:int, toPos:int):Number

Returns the calculated distance of the route.

Parameters
from:int — from The route to start with
 
toPos:int — to The route to end with

Returns
Number — The calculated total distance of 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():RouteMatrixResultsCode

Gets the result code member of this object.

Returns
RouteMatrixResultsCode
getResultsMessages()method 
public function getResultsMessages():StringCollection

Gets the result messages of this object.

Returns
StringCollection
getTime()method 
public function getTime(from:int, toPos:int):int

Returns the calculated elapsed time in seconds for the route.

Parameters
from:int — from The route to start with
 
toPos:int — to The route to end with

Returns
int — The calculated elapsed time in seconds for 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.
setCoverageName()method 
public function setCoverageName(newCoverageName:String):void

Sets the Coverage name used to perform this route.

Parameters
newCoverageName:String — newCoverageName the Coverage name used to perform this route.
setDistance()method 
public function setDistance(col:IntCollection):void

Sets the distance IntCollection. Should be used only for loadXml method.

Parameters
col:IntCollection — col The distance IntCollection.
setResultCode()method 
public function setResultCode(rc:RouteMatrixResultsCode):void

Sets the result code member of this object.

Parameters
rc:RouteMatrixResultsCode — resultCode The RouteMatrixResultsCode for this RouteMatrixResults object.

Throws
— Exception for invalid type or null/missing parameters
setTime()method 
public function setTime(col:IntCollection):void

Sets the time IntCollection. Should be used only for loadXMLOld method.

Parameters
col:IntCollection — col The time IntCollection.