gem::vrp::MiscLocation Class Reference

Defines a MiscLocation. More...

Inheritance diagram for gem::vrp::MiscLocation:

Collaboration diagram for gem::vrp::MiscLocation:

Public Member Functions
	MiscLocation ()=default
	Default constructor.
	MiscLocation (const Coordinates &coordinates)
	Create a miscLocation object with the coordinates.
	MiscLocation (const MiscLocation &)=default
	Default copy constructor Creates a copy of an existing MiscLocation object.
	MiscLocation (MiscLocation &&) noexcept=default
	Default move constructor Moves an existing MiscLocation object into a new instance.
MiscLocation &	operator= (const MiscLocation &)=default
	Default copy assignment operator.
MiscLocation &	operator= (MiscLocation &&) noexcept=default
	Default move assignment operator.
bool	operator== (MiscLocation const &miscLocation) const
	Compares two MiscLocation objects for equality.
bool	operator!= (MiscLocation const &miscLocation) const
	Compares two MiscLocation objects for inequality.
bool	getIsDepot ()
	Returns if the object is miscLocation or not.
MiscLocation &	setIsDepot (bool isDepot) noexcept
	Sets if the object is miscLocation or not.
LargeInteger	getId () const noexcept
	Retrieves the unique identifier of the miscLocation.
const CoordinatesRef	getCoordinates () const noexcept
	Retrieves the coordinates of the miscLocation point.
CoordinatesRef	getCoordinates ()
	Provides direct access to modify the coordinates of the miscLocation.
MiscLocation &	setCoordinates (const Coordinates &coords) noexcept
	Sets the coordinates of the miscLocation point.
const StringRef	getAlias () const noexcept
	Retrieves the alias of this miscLocation.
MiscLocation &	setAlias (const String &alias) noexcept
	Sets the alias for this miscLocation.
const AddressInfoRef	getAddress () const noexcept
	Retrieves the address associated with the miscLocation point.
MiscLocation &	setAddress (const AddressInfo &address) noexcept
	Sets the address for the miscLocation point.

Detailed Description

Defines a MiscLocation.

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

Constructor & Destructor Documentation

MiscLocation()

gem::vrp::MiscLocation::MiscLocation ( const Coordinates & coordinates )

inline

Create a miscLocation object with the coordinates.

Parameters

coordinates

A Coordinates object containing the initial values for the location's coordinates.

Member Function Documentation

getAddress()

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

inlinenoexcept

Retrieves the address associated with the miscLocation point.

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

Returns

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

getAlias()

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

inlinenoexcept

Retrieves the alias of this miscLocation.

Returns

The alias as a StringRef.

getCoordinates() [1/2]

CoordinatesRef gem::vrp::MiscLocation::getCoordinates ( )

inline

Provides direct access to modify the coordinates of the miscLocation.

Returns

A reference to the Coordinates object for modification.

getCoordinates() [2/2]

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

inlinenoexcept

Retrieves the coordinates of the miscLocation point.

These coordinates represent the geographical location of the miscLocation.

Returns

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

getId()

LargeInteger gem::vrp::MiscLocation::getId ( ) const

inlinenoexcept

Retrieves the unique identifier of the miscLocation.

Returns

The ID of the miscLocation, used for update or delete operations.

See also

Service::updateMiscLocation() Service::deleteMiscLocation()

getIsDepot()

bool gem::vrp::MiscLocation::getIsDepot ( )

inline

Returns if the object is miscLocation or not.

Returns

True if the object is depot, false otherwise

operator!=()

bool gem::vrp::MiscLocation::operator!= ( MiscLocation const & miscLocation ) const

inline

Compares two MiscLocation objects for inequality.

Parameters

miscLocation

Another MiscLocation object to compare against.

Returns

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

operator=() [1/2]

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

default

Default copy assignment operator.

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

Returns

A reference to the current object.

operator=() [2/2]

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

defaultnoexcept

Default move assignment operator.

Moves the contents of another MiscLocation object into this one.

Returns

A reference to the current object.

operator==()

bool gem::vrp::MiscLocation::operator== ( MiscLocation const & miscLocation ) const

inline

Compares two MiscLocation objects for equality.

Parameters

miscLocation

Another MiscLocation object to compare against.

Returns

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

setAddress()

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

inlinenoexcept

Sets the address for the miscLocation point.

Parameters

address

The new address for the miscLocation point.

Returns

A reference to this MiscLocation object after the modification

setAlias()

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

inlinenoexcept

Sets the alias for this miscLocation.

Parameters

alias

The new alias as a String.

Returns

A reference to this MiscLocation object after modification

setCoordinates()

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

inlinenoexcept

Sets the coordinates of the miscLocation point.

Parameters

coords

The new geographical coordinates for the miscLocation point.

Returns

A reference to this MiscLocation object after the modification.

setIsDepot()

MiscLocation & gem::vrp::MiscLocation::setIsDepot ( bool isDepot )

inlinenoexcept

Sets if the object is miscLocation or not.

Parameters

isDepot

True if the object is depot, false otherwise

Returns

A reference to this MiscLocation object after modification.