VgRoutingModule::VgIRoute Interface Reference

Inheritance diagram for VgRoutingModule::VgIRoute:

Public Member Functions
virtual	~VgIRoute ()
virtual double	getLength () const =0
virtual double	getDuration () const =0
virtual const std::vector< int > &	getDestinationIndices ()=0
virtual const VgRoutingModule::VgIRouteRequestParameters &	getRequestParameters ()=0
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	VgReferenced (const VgReferenced &pThis)
virtual	~VgReferenced ()
VgReferenced &	operator= (const VgReferenced &pThis)
void	ref () const
int	unref () const
int	getNbReferences () const

Protected Member Functions
	VgIRoute ()

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

Detailed Description

VgIRoute represents a route object

Constructor & Destructor Documentation

VgRoutingModule::VgIRoute::VgIRoute ( )

inlineprotected

Constructor.

virtual VgRoutingModule::VgIRoute::~VgIRoute ( )

inlinevirtual

Destructor.

References getDestinationIndices(), getDuration(), getLength(), and getRequestParameters().

Member Function Documentation

virtual const std::vector< int >& VgRoutingModule::VgIRoute::getDestinationIndices ( )

pure virtual

Returns

vector of destination indices corresponding to the actual visit order of destinations with relation to the route request order. Its size will always be >= 1.

Version

2.1.8

Referenced by ~VgIRoute().

virtual double VgRoutingModule::VgIRoute::getDuration ( ) const

pure virtual

Returns

the route duration in seconds

Version

2.1.2

Referenced by ~VgIRoute().

virtual double VgRoutingModule::VgIRoute::getLength ( ) const

pure virtual

Returns

the route length in meters

Version

1.1.6926

Referenced by ~VgIRoute().

virtual const VgRoutingModule::VgIRouteRequestParameters& VgRoutingModule::VgIRoute::getRequestParameters ( )

pure virtual

Returns the parameters with which the route was computed. It can be used in conjunction with getDestinationIndices() to determine the real order the destinations will be visited, the first destination will be: route->getRouteRequestParamters().mDestinations[route->getDestinationIndices()[0]]

Returns

VgIRouteRequestParameters with which the route was computed. The mCallback will be NULLed to avoid circular dependencies.

Version

2.1.8

Referenced by ~VgIRoute().

---

The documentation for this interface was generated from the following file:

• VgIRoute.h