Class MQRouteOptions

Object
   |
   +--MQObject
         |
         +--MQRouteOptions

class MQRouteOptions

extends MQObject

This class is used to set various options that will affect the type of route result returned from the DoRoute function.
See:

- MQAutoRouteCovSwitch
- MQIntCollection
- MQDistanceUnits
- MQNarrativeType
- MQRouteType
- MQStringCollection

Field Detail

m_AutoRouteCovSwitch

<private> MQAutoRouteCovSwitch m_AutoRouteCovSwitch

Value to represent the MQAutoRouteCovSwitch

m_AvoidAbsGefIdList

<private> MQIntCollection m_AvoidAbsGefIdList

Value to represent the Avoid Absolute Gef Id List

m_AvoidAttrList

<private> MQStringCollection m_AvoidAttrList

Value to represent the Avoid Attribute List

m_AvoidGefIdList

<private> MQIntCollection m_AvoidGefIdList

Value to represent the Avoid Gef Id List

m_DistanceUnits

<private> MQDistanceUnits m_DistanceUnits

Value to represent the MQDistanceUnits

m_NarrativeType

<private> MQNarrativeType m_NarrativeType

Value to represent the MQNarrativeType

m_RouteType

<private> MQRouteType m_RouteType

Value to represent the MQRouteType

MQRouteOptions

MQRouteOptions()

See:
- MQAutoRouteCovSwitch
- MQIntCollection
- MQDistanceUnits
- MQNarrativeType
- MQRouteType
- MQStringCollection

getAutoRouteCovSwitch

MQAutoRouteCovSwitch getAutoRouteCovSwitch()

Returns the m_AutoRouteCovSwitch object.

Returns:
The m_AutoRouteCovSwitch object.

getAvoidAbsGefIdList

MQIntCollection getAvoidAbsGefIdList()

Returns the m_AvoidAbsGefIdList collection.

Returns:
The m_AvoidAbsGefIdList collection.

getAvoidAttrList

MQStringCollection getAvoidAttrList()

Returns the m_AvoidAttrList collection.

Returns:
The m_AvoidAttrList collection.

getAvoidGefIdList

MQIntCollection getAvoidGefIdList()

Returns the m_AvoidGefIdList collection.

Returns:
The m_AvoidGefIdList collection.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getCountryBoundaryDisplay

boolean getCountryBoundaryDisplay()

Gets the country boundary display flag

Returns:
true if a country boundary text should be displayed, false otherwise.

getCoverageName

String getCoverageName()

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

Returns:
The coverage name

getDistanceUnits

MQDistanceUnits getDistanceUnits()

Returns the m_DistanceUnits object.

Returns:
The m_DistanceUnits object.

getLanguage

String getLanguage()

Returns the language set for this RouteOptions object.

Returns:
The language set

getMaxGEFIDsPerManeuver

int getMaxGEFIDsPerManeuver()

Returns the maximum number of GEFIDs for the route options.

Returns:
The maximum number of GEFIDs

getMaxShapePointsPerManeuver

int getMaxShapePointsPerManeuver()

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

Returns:
The maximum number of shape points

getNarrativeType

MQNarrativeType getNarrativeType()

Returns the m_NarrativeType object.

Returns:
The m_NarrativeType object.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getRouteType

MQRouteType getRouteType()

Returns the m_RouteType object.

Returns:
The m_RouteType object.

getStateBoundaryDisplay

boolean getStateBoundaryDisplay()

Gets the state boundary display flag

Returns:
true if a state boundary text should be displayed, false otherwise.

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.

setAutoRouteCovSwitch

void setAutoRouteCovSwitch(<MQAutoRouteCovSwitch> autoRouteCovSwitch)

Sets the m_AutoRouteCovSwitch collection.

Parameters:
autoRouteCovSwitch - The object to set m_AutoRouteCovSwitch to.

setAvoidAbsGefIdList

void setAvoidAbsGefIdList(avoidAbsGefIdList)

Sets the m_AvoidAbsGefIdList collection.

Parameters:
AvoidAbsGefIdList - The collection to set m_AvoidAbsGefIdList to.

setAvoidAttrList

void setAvoidAttrList(avoidAttrList)

Sets the m_AvoidAttrList collection.

Parameters:
AvoidAttrList - The collection to set m_AvoidAttrList to.

setAvoidGefIdList

void setAvoidGefIdList(avoidGefIdList)

Sets the m_AvoidGefIdList collection.

Parameters:
AvoidGefIdList - The collection to set m_AvoidGefIdList to.

setCountryBoundaryDisplay

void setCountryBoundaryDisplay(<Boolean> bFlag)

Sets the country boundary display flag.

Parameters:
bFlag - The country boundary display flag

setCoverageName

void setCoverageName(<String> newCoverageName)

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

Parameters:
newCoverageName - The coverage name

setDistanceUnits

void setDistanceUnits(<MQDistanceUnits> distanceUnits)

Sets the m_DistanceUnits collection.

Parameters:
distanceUnits - The object to set m_DistanceUnits to.

setLanguage

void setLanguage(<String> strLanguage)

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 - containing a valid language

setMaxGEFIDsPerManeuver

void setMaxGEFIDsPerManeuver(<int> nCount)

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 - with the maximum number of GEFIDs.

setMaxShapePointsPerManeuver

void setMaxShapePointsPerManeuver(<int> nCount)

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 - with the maximum number of shape points.

setNarrativeType

void setNarrativeType(<MQNarrativeType> narrativeType)

Sets the m_NarrativeType collection.

Parameters:
narrativeType - The object to set m_NarrativeType to.

setRouteType

void setRouteType(<MQRouteType> routeType)

Sets the m_RouteType collection.

Parameters:
routeType - The object to set m_RouteType to.

setStateBoundaryDisplay

void setStateBoundaryDisplay(<Boolean> bFlag)

Sets the state boundary display flag.

Parameters:
bFlag - The state boundary display flag