VgRoutingModule Namespace Reference

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

Classes
interface	VgIRoute
	VgIRoute represents a route object. More...
interface	VgIRouteCallback
	VgIRouteCallback provides an interface for the route solver to communicate with the route requester. More...
struct	VgIRouteGeometryDescriptor
	A route geometry descriptor object. More...
class	VgIRouteConverter
	VgIRouteConverter provides a mechanism for converting a VgIRoute into a geometry object(s) displayable by the Vg3DModule. More...
interface	VgIRouteConverterFactory
	VgIRouteConverterFactory Provides an interface for creating a VgIRouteConverter. More...
interface	VgIRouteRequest
	VgIRouteRequest provides an interface to allow the route requester to communicate with the route solver. More...
class	VgIRoutingModule
	VgIRoutingModule provides access to routing related objects. More...
interface	VgIRoutingNode
	This class is an opaque pointer class to routing nodes from the routing module. More...
struct	VgIRouteRequestParameters
	An object containing parameters to perform a route request. More...
struct	VgIRoutingNodeParameters
	An object containing parameters to perform a getRoutingNode from a position. More...
interface	VgIRoutingSolver
	VgIRoutingSolver will calculate a route between several waypoints. More...

Typedefs
typedef std::vector < VgIRouteGeometryDescriptor >	VgIRouteGeometryDescriptorVector

Enumerations
enum	VgRouteRequestStatus { eSuccess, eError }
	The status of a route request. More...
enum	VgIRouteConverterType { e2D, e3D }
	Available types of supported route converters. More...
enum	VgIRouteRequestType { eShortest, eFastest }
	The different route request types available. More...
enum	VgIRouteDestinationsOrder { eInOrder, eOptimal, eOptimalFinishOnLast }
	The different ways to interpret multiple destinations, these options do not change the behavior if there is only one mDestination. More...
enum	VgIRoutingNodeOption { eRoutingNodeOptionsAnyNode, eRoutingNodeOptionsOnEdge, eRoutingNodeOptionsAccessOnly }
	Options to determine how a routing node for getRoutingNode from positions is found. More...

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.

Version

2.1.4

Enumerator
eInOrder	Indicates a that the destinations should be traversed in order.
eOptimal	Indicates a that the destinations should be traversed in the order that minimizes the overall distance or time: e.g. travelling salesman order
eOptimalFinishOnLast	Indicates a 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.

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	default, finds the closest node to that position
eRoutingNodeOptionsOnEdge	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.