gem::EntranceLocations Class Reference

EntranceLocations object. More...

Inheritance diagram for gem::EntranceLocations:

Collaboration diagram for gem::EntranceLocations:

Public Member Functions
	EntranceLocations (const EntranceLocations &)=default
	Default copy constructor.
	EntranceLocations (EntranceLocations &&loc)=default
	Default move constructor noexcept is deduced.
EntranceLocations &	operator= (const EntranceLocations &loc)=default
	Default copy assignment.
EntranceLocations &	operator= (EntranceLocations &&loc)=default
	Default move assignment noexcept is deduced.
int	getCount () const
	Get the entrances count.
EEntranceLocationType	getType (int index) const noexcept
	Get the entrance type specified by index.
const CoordinatesRef	getCoordinates (int index) const noexcept
	Get the entrance coordinates specified by index.
int	addEntranceLocation (EEntranceLocationType entranceType, Coordinates const &coordinates) noexcept
	Add new entrance location.
void	clear () noexcept
	Clear all entrance locations.

Detailed Description

EntranceLocations object.

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

Constructor & Destructor Documentation

EntranceLocations()

gem::EntranceLocations::EntranceLocations ( EntranceLocations && loc )

default

Default move constructor noexcept is deduced.

Parameters

loc	EntranceLocations object to move from

Member Function Documentation

addEntranceLocation()

int gem::EntranceLocations::addEntranceLocation ( EEntranceLocationType entranceType, Coordinates const & coordinates )

inlinenoexcept

Add new entrance location.

Parameters

entranceType	Type of entrance location. (ex vehicle, pedestrian)
coordinates	Coordinates where the entrance is located.

Returns

no error code if the entrance location was added successfully, error code otherwise.

getCoordinates()

const CoordinatesRef gem::EntranceLocations::getCoordinates ( int index ) const

inlinenoexcept

Get the entrance coordinates specified by index.

Returns

default in case the index is invalid.

Parameters

index

Index of entrance location for which the coordinates will be returned.

See also

Coordinates

getCount()

int gem::EntranceLocations::getCount ( ) const

inline

Get the entrances count.

Returns

Number of entrance locations.

getType()

EEntranceLocationType gem::EntranceLocations::getType ( int index ) const

inlinenoexcept

Get the entrance type specified by index.

Returns

UnknownAccessType In case the entrance type is unknown or the index is invalid.

Parameters

index

Index of entrance location for which the type will be returned.

See also

EEntranceLocationType

operator=() [1/2]

EntranceLocations & gem::EntranceLocations::operator= ( const EntranceLocations & loc )

default

Default copy assignment.

Parameters

loc	EntranceLocations object to copy from

Returns

EntranceLocations& Reference to this object

operator=() [2/2]

EntranceLocations & gem::EntranceLocations::operator= ( EntranceLocations && loc )

default

Default move assignment noexcept is deduced.

Parameters

loc	EntranceLocations object to move from

Returns

EntranceLocations& Reference to this object