gem::vrp::rs::Rider Class Reference

Rider object. More...

Inheritance diagram for gem::vrp::rs::Rider:

Collaboration diagram for gem::vrp::rs::Rider:

Public Member Functions
int	request (const gem::Route &route) noexcept
	Request a ride.
int	cancel () noexcept
	Cancel current ride.
Ride	getRequestedRide () const noexcept
	Get last requested ride.
ERiderStatus	getState () const noexcept
	Get rider current state.
gem::Route	getRequestedRoute () const noexcept
	Get requested route via request method.
sense::DataSourcePtr	getDriverPositionDataSource () const noexcept
	Get driver position data source.
TimeDistance	getDriverTimeDistance () const noexcept
	Get driver estimated time-distance to arrival.

Static Public Member Functions
static StrongPointer< Rider >	produce (RiderListener listener)
	Create a Rider object.

Detailed Description

Rider object.

Member Function Documentation

cancel()

int gem::vrp::rs::Rider::cancel ( )

inlinenoexcept

Cancel current ride.

Returns

The execution error code

getDriverPositionDataSource()

sense::DataSourcePtr gem::vrp::rs::Rider::getDriverPositionDataSource ( ) const

inlinenoexcept

Get driver position data source.

Driver data source with current driver positions

Returns

The data source of the Driver

getDriverTimeDistance()

TimeDistance gem::vrp::rs::Rider::getDriverTimeDistance ( ) const

inlinenoexcept

Get driver estimated time-distance to arrival.

Returns

The driver;s estimated time-distance to arrival as a TimeDistance

getRequestedRide()

Ride gem::vrp::rs::Rider::getRequestedRide ( ) const

inlinenoexcept

Get last requested ride.

Returns

The last requested ride

getRequestedRoute()

gem::Route gem::vrp::rs::Rider::getRequestedRoute ( ) const

inlinenoexcept

Get requested route via request method.

Returns

The requested route

getState()

ERiderStatus gem::vrp::rs::Rider::getState ( ) const

inlinenoexcept

Get rider current state.

Returns

The rider's status as an ERiderStatus enumeration value

produce()

StrongPointer< Rider > gem::vrp::rs::Rider::produce ( RiderListener listener )

inlinestatic

Create a Rider object.

Parameters

[in]

listener

The rider listener

Returns

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

request()

int gem::vrp::rs::Rider::request ( const gem::Route & route )

inlinenoexcept

Request a ride.

Parameters

route

The route for which the ride is requested

Returns

The execution error code