VgRoutingModule Namespace Reference

Classes
interface	VgIRoute
interface	VgIRouteCallback
class	VgIRouteConverter
interface	VgIRouteConverterFactory
struct	VgIRouteGeometryDescriptor
interface	VgIRouteRequest
struct	VgIRouteRequestParameters
class	VgIRoutingModule
interface	VgIRoutingNode
struct	VgIRoutingNodeParameters
interface	VgIRoutingSolver

Typedefs
typedef std::vector< VgIRouteGeometryDescriptor >	VgIRouteGeometryDescriptorVector

Enumerations

Detailed Description

The namespace defines all the needed interfaces to interact with the Routing module.

Typedef Documentation

typedef std::vector< VgIRouteGeometryDescriptor > VgRoutingModule::VgIRouteGeometryDescriptorVector

Enumeration Type Documentation

enum VgRoutingModule::VgIRouteConverterType

Available types of supported route converters.

Enumerator
e2D	Converts routes for displaying within a 2D map.
e3D	Converts routes for displaying within a 3D map.

enum VgRoutingModule::VgIRouteDestinationsOrder

The different ways to interpret multiple destinations, these options do not change the behavior if there is only one mDestination. For optimal routes there is a practical limit on 5-6 destinations. use VgRoutingModule::VgIRoute::getDestinationIndices() to obtain the actual visit order of the destinations.

See also

VgRoutingModule::VgIRoute::getDestinationIndices

Version

2.1.4

2.1.8 added destination order eClosest.

Enumerator
eInOrder	Indicates a that the destinations should be traversed in order
eOptimal	Indicates that the destinations should be traversed in the order that minimizes the overall distance or time: e.g. travelling salesman order
eOptimalFinishOnLast	Indicates that the destinations should be traversed in the order that minimizes the overall distance or time: e.g. travelling salesman order, but always finish on the last routing node of mDestinations. For example, you enter a shop, you visit the different stands and you finish at the exit. This is the default.
eClosest	Indicates that one destination should be returned, the one that is closest (be fastest or shortest).
eDestinationOrderMax	Should not be used.

enum VgRoutingModule::VgIRouteRequestType

The different route request types available.

Version

2.0.7729

Enumerator
eShortest	Indicates a request for a route that optimizes distance
eFastest	Indicates a request for a route that optimizes time

enum VgRoutingModule::VgIRoutingNodeOption

Options to determine how a routing node for getRoutingNode from positions is found.

Version

2.1.4

Enumerator
eRoutingNodeOptionsAnyNode	finds the closest node to that position
eRoutingNodeOptionsOnEdge	Default, Find the closest edge, and start or end the route in the middle of an edge this it the default option.
eRoutingNodeOptionsAccessOnly	find the closest access point

enum VgRoutingModule::VgRouteRequestStatus

The status of a route request

Enumerator
eSuccess	Request was successful
eError	Request failure for unspecified reason