gem::vrp::rs::Driver Class Reference

Driver object. More...

Inheritance diagram for gem::vrp::rs::Driver:

Collaboration diagram for gem::vrp::rs::Driver:

Public Member Functions
int	accept (const Ride &ride) noexcept
	Accept a ride.
int	finish () noexcept
	Finish current ride.
int	cancel (const Ride &ride) noexcept
	Cancel ride.
int	pickup () noexcept
	Pickup rider.
const DriverPreferences &	getPreferences () const noexcept
	Get the driver preferences.
RideList	getRides () const noexcept
	Get all driver active rides in execution order.
Ride	getCurrentRide () const noexcept
	Get driver current ride.
gem::Route	getNavigationRoute () const noexcept
	Get driver 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

accept()

int gem::vrp::rs::Driver::accept ( const Ride & ride )

inlinenoexcept

Accept a ride.

Parameters

ride	A const reference to the Ride object which is accepted

Returns

The execution error code

cancel()

int gem::vrp::rs::Driver::cancel ( const Ride & ride )

inlinenoexcept

Cancel ride.

Parameters

ride	Identify the ride to cancel, current or next

Returns

The execution error code

finish()

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

inlinenoexcept

Finish current ride.

Returns

The execution error code

getCurrentRide()

Ride gem::vrp::rs::Driver::getCurrentRide ( ) const

inlinenoexcept

Get driver current ride.

Returns

The driver's current ride

getNavigationRoute()

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

inlinenoexcept

Get driver corresponding navigation route.

Returns

The driver's corresponding navigation route

getPreferences()

const DriverPreferences & gem::vrp::rs::Driver::getPreferences ( ) const

inlinenoexcept

Get the driver preferences.

Returns

A reference to the driver preferences

getRides()

RideList gem::vrp::rs::Driver::getRides ( ) const

inlinenoexcept

Get all driver active rides in execution order.

Returns

All driver active rides in execution order as a RideList

getState()

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

inlinenoexcept

Get driver current state.

Returns

The driver's current state as a EDriverStatus enumeration value

pickup()

int gem::vrp::rs::Driver::pickup ( )

inlinenoexcept

Pickup rider.

Returns

The execution error code

produce()

StrongPointer< Driver > gem::vrp::rs::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.

setTestMode()

void gem::vrp::rs::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