Class MQRouteMatrixResults

Object
   |
   +--MQObject
         |
         +--MQRouteMatrixResults

class MQRouteMatrixResults

extends MQObject

Contains the results of a route matrix request.
See:

- MQRouteMatrixResultsCode
- MQStringCollection
- MQIntCollection

Field Detail

m_Distance

<private> MQIntCollection m_Distance

Value to represent the distance matrix

m_LocationCount

<private> int m_LocationCount

Value to represent the count of locations

m_ResultCode

<private> MQRouteMatrixResultsCode m_ResultCode

Value to represent the result code

m_ResultMessages

<private> MQStringCollection m_ResultMessages

Value to represent the result messages

m_Time

<private> MQIntCollection m_Time

Value to represent the time matrix

MQRouteMatrixResults

MQRouteMatrixResults()

Constructs a new MQRouteMatrixResults object.

See:
- MQRouteMatrixResultsCode
- MQStringCollection
- MQIntCollection

getAllToAllFlag

Boolean getAllToAllFlag()

Gets the all-to-all flag.

Returns:
Returns the allToAll flag. True if the matrix is from each location to each other, False if from location 0 to all others.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getCoverageName

String getCoverageName()

Gets the Coverage name used to perform this route.

Returns:
The value of CoverageName

getDistance

Double getDistance(<int> from, <int> to)

Returns the calculated distance of the route.

Parameters:
from - The route to start with
to - The route to end with

Returns:
The calculated total distance of the route.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getResultCode

MQRouteMatrixResultsCode getResultCode()

Gets the result code member of this object.

Returns:
The MQRouteMatrixResultsCode for this MQRouteMatrixResults object.

getResultsMessages

MQStringCollection getResultsMessages()

Gets the result messages of this object.

Returns:
The MQStringCollection for this object.

getTime

int getTime(<int> from, <int> to)

Returns the calculated elapsed time in seconds for the route.

Parameters:
from - The route to start with
to - The route to end with

Returns:
The calculated elapsed time in seconds for the route.

loadXml

void loadXml(<String> strXml)

Assigns the xml that relates to this object.

Parameters:
strXml - the xml to be assigned.

saveXml

String saveXml()

Build an xml string that represents this object.

Returns:
The xml string.

setCoverageName

void setCoverageName(<String> newCoverageName)

Sets the Coverage name used to perform this route.

Parameters:
newCoverageName - the Coverage name used to perform this route.

setDistance

void setDistance(<MQIntCollection> col)

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

Parameters:
col - The distance MQIntCollection.

setResultCode

void setResultCode(rc)

Sets the result code member of this object.

Parameters:
resultCode - The MQRouteMatrixResultsCode for this MQRouteMatrixResults object.

Throws:
- Some Exception for invalid type or null/missing parameters

setResultMessages

void setResultMessages(<MQStringCollection> col)

Sets the ResultMessages MQStringCollection. Should be used only for loadXml method.

Parameters:
col - The ResultMessages MQStringCollection.

setTime

void setTime(<MQIntCollection> col)

Sets the time MQIntCollection. Should be used only for loadXml method.

Parameters:
col - The time MQIntCollection.