Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::vrp::rs::Ride Class Reference

Ride object. More...

Inheritance diagram for gem::vrp::rs::Ride:
Collaboration diagram for gem::vrp::rs::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.
Rideoperator= (const Ride &)=default
 Default copy assignment operator.
Rideoperator= (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 preferences.
const LandmarkRef getPickup () const noexcept
 Get pickup location.
ParameterList getInfo () const noexcept
 Get rider info as a list of parameters.

Detailed Description

Ride object.

Member Function Documentation

◆ getId()

LargeInteger gem::vrp::rs::Ride::getId ( ) const
inlinenoexcept

Get ride id.

Returns
The id of the ride as LargeInteger

◆ getInfo()

ParameterList gem::vrp::rs::Ride::getInfo ( ) const
inlinenoexcept

Get rider info as a list of parameters.

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

◆ getPickup()

const LandmarkRef gem::vrp::rs::Ride::getPickup ( ) const
inlinenoexcept

Get pickup location.

Returns
The rider's pickup location as a Landmark object

◆ getPreferences()

const RoutePreferencesRef gem::vrp::rs::Ride::getPreferences ( ) const
inlinenoexcept

Get ride preferences.

Returns
The route preferences of the ride

◆ getStops()

const LandmarkListRef gem::vrp::rs::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::rs::Ride::operator!= ( Ride const & ride) const
inline

Compares two Ride objects for equality.

Parameters
rideAnother Ride object to compare against.
Returns
True if both Ride objects represent the same data, false otherwise.

◆ operator=() [1/2]

Ride & gem::vrp::rs::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::rs::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::rs::Ride::operator== ( Ride const & ride) const
inline

Compares two Ride objects for equality.

Parameters
rideAnother Ride object to compare against.
Returns
True if both Ride objects represent the same data, false otherwise.