gem::vrp::Destination Class Reference

Defines a destination of an optimization or route. More...

Inheritance diagram for gem::vrp::Destination:

Collaboration diagram for gem::vrp::Destination:

Public Member Functions
	Destination ()=default
	Default constructor.
	Destination (const Destination &)=default
	Default copy constructor.
	Destination (Destination &&) noexcept=default
	Default move constructor noexcept is deduced.
Destination &	operator= (const Destination &)=default
	Default copy assignment operator.
Destination &	operator= (Destination &&) noexcept=default
	Default move assignment operator.
bool	operator== (Destination const &destination) const
	Compares two Destination objects for equality.
bool	operator!= (Destination const &destination) const
	Compares two Destination objects for inequality.
const CoordinatesRef	getCoordinates () const noexcept
	Retrieves the coordinates of the destination point.
CoordinatesRef	getCoordinates ()
	Provides direct access to modify the coordinates of the destination point.
Destination &	setCoordinates (const Coordinates &coords) noexcept
	Sets the coordinates of the destination point.
const CoordinatesRef	getMatchedCoordinates () const noexcept
	Retrieves the matched coordinates of the destination point.
const StringRef	getAlias () const noexcept
	Retrieves the alias of this destination.
Destination &	setAlias (const String &alias) noexcept
	Sets the alias for this destination.
const AddressInfoRef	getAddress () const noexcept
	Retrieves the address associated with the destination point.
Destination &	setAddress (const AddressInfo &address) noexcept
	Sets the address for the destination point.
const TimeRef	getArrivalTime () const noexcept
	Retrieves the scheduled arrival time at this point.
float	getTraveledDistance () const noexcept
	Retrieves the total traveled distance until this point.

Detailed Description

Defines a destination of an optimization or route.

Implements share-read / copy-on-write Api object over IDestination.

Member Function Documentation

getAddress()

const AddressInfoRef gem::vrp::Destination::getAddress ( ) const

inlinenoexcept

Retrieves the address associated with the destination point.

This address provides a human-readable location for the destination point, complementing the coordinates.

Returns

A constant reference to the AddressInfo object representing the destination address.

getAlias()

const StringRef gem::vrp::Destination::getAlias ( ) const

inlinenoexcept

Retrieves the alias of this destination.

Returns

The alias as a StringRef.

getArrivalTime()

const TimeRef gem::vrp::Destination::getArrivalTime ( ) const

inlinenoexcept

Retrieves the scheduled arrival time at this point.

This time indicates when the vehicle is expected to arrive at the destination point.

Returns

A constant reference to the Time object representing the destination time.

getCoordinates() [1/2]

CoordinatesRef gem::vrp::Destination::getCoordinates ( )

inline

Provides direct access to modify the coordinates of the destination point.

This allows for setting or updating the geographical location where the vehicle ends the route.

Returns

A reference to the Coordinates object for modification.

getCoordinates() [2/2]

const CoordinatesRef gem::vrp::Destination::getCoordinates ( ) const

inlinenoexcept

Retrieves the coordinates of the destination point.

These coordinates represent the geographical location where the vehicle ends the route.

Returns

A constant reference to the Coordinates object representing the destination location.

getMatchedCoordinates()

const CoordinatesRef gem::vrp::Destination::getMatchedCoordinates ( ) const

inlinenoexcept

Retrieves the matched coordinates of the destination point.

These coordinates represent the geographical matched location where the vehicle ends the route.

Returns

A constant reference to the Coordinates object representing the destination location.

getTraveledDistance()

float gem::vrp::Destination::getTraveledDistance ( ) const

inlinenoexcept

Retrieves the total traveled distance until this point.

Returns

The total distance traveled by the vehicle as a float, in the unit set in the ConfigurationParameters.

operator!=()

bool gem::vrp::Destination::operator!= ( Destination const & destination ) const

inline

Compares two Destination objects for inequality.

Parameters

destination

Another Destination object to compare against.

Returns

True if the Destination objects do not represent the same data, false otherwise.

operator=() [1/2]

Destination & gem::vrp::Destination::operator= ( const Destination & )

default

Default copy assignment operator.

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

Returns

A reference to the current object.

operator=() [2/2]

Destination & gem::vrp::Destination::operator= ( Destination && )

defaultnoexcept

Default move assignment operator.

Moves the contents of another Destination object into this one.

Returns

A reference to the current object.

operator==()

bool gem::vrp::Destination::operator== ( Destination const & destination ) const

inline

Compares two Destination objects for equality.

Parameters

destination

Another Destination object to compare against.

Returns

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

setAddress()

Destination & gem::vrp::Destination::setAddress ( const AddressInfo & address )

inlinenoexcept

Sets the address for the destination point.

Parameters

address

The new address for the destination point.

Returns

A reference to this Destination object after the modification.

setAlias()

Destination & gem::vrp::Destination::setAlias ( const String & alias )

inlinenoexcept

Sets the alias for this destination.

Parameters

alias

The new alias as a String.

Returns

A reference to this Destination object after modification.

setCoordinates()

Destination & gem::vrp::Destination::setCoordinates ( const Coordinates & coords )

inlinenoexcept

Sets the coordinates of the destination point.

Parameters

coords

The new geographical coordinates for the destination point.

Returns

A reference to this Destination object after the modification.