gem::vrp::dlv::Driver Class Reference

Driver object. More...

Inheritance diagram for gem::vrp::dlv::Driver:

Collaboration diagram for gem::vrp::dlv::Driver:

Public Member Functions
int	completeDelivery () noexcept
	Complete current delivery in the ride deliveries chain.
int	skipDelivery () noexcept
	Skip the current delivery.
int	cancel () noexcept
	Cancel the ride in progress.
int	reoptimize () noexcept
	Reoptimize the ride in progress A new ride with the skipped or failed orders will be returned.
int	finish () noexcept
	Finish the ride in progress.
DriverPreferences	getPreferences () noexcept
	Get preferences.
Ride	getRide () const noexcept
	Get current driver ride.
gem::Route	getNavigationRoute () const noexcept
	Get driver ride corresponding navigation route.
EDriverStatus	getState () const noexcept
	Get driver current state.
void	setTestMode (bool test) noexcept
	Set the API test mode.
void	getTestMode () noexcept
	Get the API test mode.

Static Public Member Functions
static StrongPointer< Driver >	produce (const DriverPreferences &prefs, DriverListener listener)
	Create a Driver object.

Detailed Description

Driver object.

Member Function Documentation

cancel()

int gem::vrp::dlv::Driver::cancel ( )

inlinenoexcept

Cancel the ride in progress.

Returns

The execution error code

completeDelivery()

int gem::vrp::dlv::Driver::completeDelivery ( )

inlinenoexcept

Complete current delivery in the ride deliveries chain.

Returns

The execution error code

finish()

int gem::vrp::dlv::Driver::finish ( )

inlinenoexcept

Finish the ride in progress.

Returns

The execution error code

getNavigationRoute()

gem::Route gem::vrp::dlv::Driver::getNavigationRoute ( ) const

inlinenoexcept

Get driver ride corresponding navigation route.

Returns

The driver's navigation route. If driver navigation is not started the returned value is a default value

getPreferences()

DriverPreferences gem::vrp::dlv::Driver::getPreferences ( )

inlinenoexcept

Get preferences.

Returns

The driver preferences

getRide()

Ride gem::vrp::dlv::Driver::getRide ( ) const

inlinenoexcept

Get current driver ride.

Returns

The current driver ride. If there is no active ride in progress the returned value is a default value

getState()

EDriverStatus gem::vrp::dlv::Driver::getState ( ) const

inlinenoexcept

Get driver current state.

Returns

The driver's current state as a EDriverStatus enumeration value

produce()

StrongPointer< Driver > gem::vrp::dlv::Driver::produce ( const DriverPreferences & prefs, DriverListener listener )

inlinestatic

Create a Driver object.

Parameters

[in]	prefs	The driver preferences
[in]	listener	The driver listener

Returns

A strong pointer to the Driver instance, or an empty pointer if creation fails.

reoptimize()

int gem::vrp::dlv::Driver::reoptimize ( )

inlinenoexcept

Reoptimize the ride in progress A new ride with the skipped or failed orders will be returned.

Returns

The execution error code

setTestMode()

void gem::vrp::dlv::Driver::setTestMode ( bool test )

inlinenoexcept

Set the API test mode.

In test mode accepted rides are simulated instead of navigated

Parameters

test	true if the API is in test mode, false otherwise

skipDelivery()

int gem::vrp::dlv::Driver::skipDelivery ( )

inlinenoexcept

Skip the current delivery.

Returns

The execution error code