gem::vrp::dlv::Ride Class Reference

Ride object. More...

Inheritance diagram for gem::vrp::dlv::Ride:

Collaboration diagram for gem::vrp::dlv::Ride:

Public Member Functions
	Ride ()=default
	Default constructor.
	Ride (const Ride &)=default
	Default copy constructor.
	Ride (Ride &&) noexcept=default
	Default move constructor noexcept is deduced.
Ride &	operator= (const Ride &)=default
	Default copy assignment operator.
Ride &	operator= (Ride &&) noexcept=default
	Default move assignment operator.
bool	operator== (Ride const &ride) const
	Compares two Ride objects for equality.
bool	operator!= (Ride const &ride) const
	Compares two Ride objects for equality.
LargeInteger	getId () const noexcept
	Get ride id.
const LandmarkListRef	getStops () const noexcept
	Get stops list in visit order.
const RoutePreferencesRef	getPreferences () const noexcept
	Get ride routing preferences.
ParameterList	getInfo (ProgressListener listener) const noexcept
	Get ride info as a list of parameters.
ParameterList	getStopInfo (int stopIndex) const noexcept
	Get info for a stop as a list of parameters.
unsigned int	getCurrStopIdx () const noexcept
	Get the index of the current stop to be visited.

Detailed Description

Ride object.

Member Function Documentation

getCurrStopIdx()

unsigned int gem::vrp::dlv::Ride::getCurrStopIdx ( ) const

inlinenoexcept

Get the index of the current stop to be visited.

Returns

The stop index as a unsigned int

getId()

LargeInteger gem::vrp::dlv::Ride::getId ( ) const

inlinenoexcept

Get ride id.

Returns

The id of the ride as LargeInteger

getInfo()

ParameterList gem::vrp::dlv::Ride::getInfo ( ProgressListener listener ) const

inlinenoexcept

Get ride info as a list of parameters.

Parameters

[in]

listener

Operation progress listener.

Returns

The ride info as parameters list. See "Ride parameters ids" for possible ids

getPreferences()

const RoutePreferencesRef gem::vrp::dlv::Ride::getPreferences ( ) const

inlinenoexcept

Get ride routing preferences.

Returns

The route preferences of the ride

getStopInfo()

ParameterList gem::vrp::dlv::Ride::getStopInfo ( int stopIndex ) const

inlinenoexcept

Get info for a stop as a list of parameters.

Parameters

[in]

stopIndex

The index of the stop in the visit order

Returns

The stop info as parameters list

getStops()

const LandmarkListRef gem::vrp::dlv::Ride::getStops ( ) const

inlinenoexcept

Get stops list in visit order.

Returns

The stops of the ride as a list of landmarks

operator!=()

bool gem::vrp::dlv::Ride::operator!= ( Ride const & ride ) const

inline

Compares two Ride objects for equality.

Parameters

ride	Another Ride object to compare against.

Returns

True if both Ride objects represent the same data, false otherwise.

operator=() [1/2]

Ride & gem::vrp::dlv::Ride::operator= ( const Ride & )

default

Default copy assignment operator.

Replaces the contents of this object with a copy of another Ride object.

Returns

A reference to the current object.

operator=() [2/2]

Ride & gem::vrp::dlv::Ride::operator= ( Ride && )

defaultnoexcept

Default move assignment operator.

Moves the contents of another Ride object into this one.

Returns

A reference to the current object.

operator==()

bool gem::vrp::dlv::Ride::operator== ( Ride const & ride ) const

inline

Compares two Ride objects for equality.

Parameters

ride	Another Ride object to compare against.

Returns

True if both Ride objects represent the same data, false otherwise.