com.visioglobe.libVisioDevKit

Class VgIRouteRequestParameters

java.lang.Object

com.visioglobe.libVisioDevKit.VgIRouteRequestParameters

public class VgIRouteRequestParameters
extends java.lang.Object

An object containing parameters to perform a route request.

Constructor Summary

Constructors

Constructor and Description
VgIRouteRequestParameters()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete()
VgIRouteCallbackRefPtr	getMCallback() Callback that will be notified when the route has been commputed.
VgIRoutingNodeRefPtrVector	getMDestinations() Contains a list of waypoints that must be present on the route.
VgStringSet	getMExcludedAttributes() Attributes to be excluded from the route (e.g.
VgStringSet	getMExcludedModalities() Modalities to be excluded from the route (e.g.
VgIRoutingNodeRefPtr	getMOrigin() Start point of route.
VgIRouteRequestType	getMRequestType() Tells which apsect of route to optimize (time or distance) default is time
void	setMCallback(VgIRouteCallbackRefPtr value) Callback that will be notified when the route has been commputed.
void	setMDestinations(VgIRoutingNodeRefPtrVector value) Contains a list of waypoints that must be present on the route.
void	setMExcludedAttributes(VgStringSet value) Attributes to be excluded from the route (e.g.
void	setMExcludedModalities(VgStringSet value) Modalities to be excluded from the route (e.g.
void	setMOrigin(VgIRoutingNodeRefPtr value) Start point of route.
void	setMRequestType(VgIRouteRequestType value) Tells which apsect of route to optimize (time or distance) default is time

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VgIRouteRequestParameters

public VgIRouteRequestParameters()

Method Detail

delete

public void delete()

setMRequestType

public void setMRequestType(VgIRouteRequestType value)

Tells which apsect of route to optimize (time or distance) default is time

getMRequestType

public VgIRouteRequestType getMRequestType()

Tells which apsect of route to optimize (time or distance) default is time

setMOrigin

public void setMOrigin(VgIRoutingNodeRefPtr value)

Start point of route.

Note:

Use VgIRoutingSolver::getRoutingNode to get the corresponding routing node to either a position or a place id.

getMOrigin

public VgIRoutingNodeRefPtr getMOrigin()

Start point of route.

Note:

Use VgIRoutingSolver::getRoutingNode to get the corresponding routing node to either a position or a place id.

setMDestinations

public void setMDestinations(VgIRoutingNodeRefPtrVector value)

Contains a list of waypoints that must be present on the route.

Note:

Currently, only the position at the front of the vector is used as a destination for the computed route.

getMDestinations

public VgIRoutingNodeRefPtrVector getMDestinations()

Contains a list of waypoints that must be present on the route.

Note:

Currently, only the position at the front of the vector is used as a destination for the computed route.

setMExcludedAttributes

public void setMExcludedAttributes(VgStringSet value)

Attributes to be excluded from the route (e.g. "stairs" for disabled persons) Use VgIRoutingModule::getAllAttributeNames to retreive a list of attributes available within the current routing network.

getMExcludedAttributes

public VgStringSet getMExcludedAttributes()

Attributes to be excluded from the route (e.g. "stairs" for disabled persons) Use VgIRoutingModule::getAllAttributeNames to retreive a list of attributes available within the current routing network.

setMExcludedModalities

public void setMExcludedModalities(VgStringSet value)

Modalities to be excluded from the route (e.g. 'do not use car' or 'do not use shuttles) Use VgIRoutingModule::getAllModalityNames to retreive a list of modalities available within the current routing network.

getMExcludedModalities

public VgStringSet getMExcludedModalities()

Modalities to be excluded from the route (e.g. 'do not use car' or 'do not use shuttles) Use VgIRoutingModule::getAllModalityNames to retreive a list of modalities available within the current routing network.

setMCallback

public void setMCallback(VgIRouteCallbackRefPtr value)

Callback that will be notified when the route has been commputed. This is required in order to receive the result of the computed route.

getMCallback

public VgIRouteCallbackRefPtr getMCallback()

Callback that will be notified when the route has been commputed. This is required in order to receive the result of the computed route.