Detailed Description

Uniquely identifies a bulb in the Inertial space.

This consists of the concatenation of the bulb's ID, the ID of the bulb group that contains the bulb, and the the ID of the traffic light that contains the bulb group.

String representation of this ID is: "`traffic_light_id().string()`-`bulb_group_id.string()`-`bulb_group_id.string()`"

See also: UniqueBulbId::delimiter() as it provides the "-" string in between IDs.

#include <include/maliput/api/rules/traffic_lights.h>

Inheritance diagram for UniqueBulbId:

[legend]

Public Member Functions
	UniqueBulbId ()
	A default constructor. More...

	UniqueBulbId (const TrafficLight::Id &traffic_light_id, const BulbGroup::Id &bulb_group_id, const Bulb::Id &bulb_id)
	Constructs a UniqueBulbId. More...

bool	operator== (const UniqueBulbId &rhs) const
	Tests for equality with another UniqueBulbId. More...

bool	operator!= (const UniqueBulbId &rhs) const
	Tests for inequality with another UniqueBulbId, specifically returning the opposite of operator==(). More...

const TrafficLight::Id	traffic_light_id () const

const BulbGroup::Id	bulb_group_id () const

const Bulb::Id	bulb_id () const

Public Member Functions inherited from UniqueId
	MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (UniqueId)

	UniqueId (const std::string &string)
	Constructs a UniqueId from the given `string`. More...

const std::string &	string () const
	Returns the string representation of the UniqueId. More...

bool	operator== (const UniqueId &rhs) const
	Tests for equality with another UniqueId. More...

bool	operator!= (const UniqueId &rhs) const
	Tests for inequality with another UniqueId, specifically returning the opposite of operator==(). More...

Static Public Member Functions
static const std::string	delimiter ()
	Returns "-", the string delimiter to separate IDs. More...

Friends
template<class HashAlgorithm >
void	hash_append (HashAlgorithm &hasher, const UniqueBulbId &id) noexcept
	Implements the hash_append concept. More...

Constructor & Destructor Documentation

◆ UniqueBulbId() [1/2]

UniqueBulbId ( )

A default constructor.

This was originally intended for use by boost::python bindings in downstream projects.

◆ UniqueBulbId() [2/2]

UniqueBulbId	(	const TrafficLight::Id &	traffic_light_id,
		const BulbGroup::Id &	bulb_group_id,
		const Bulb::Id &	bulb_id
	)

Constructs a UniqueBulbId.

Member Function Documentation

◆ bulb_group_id()

const BulbGroup::Id bulb_group_id ( ) const

◆ bulb_id()

const Bulb::Id bulb_id ( ) const

◆ delimiter()

const std::string delimiter ( )

static

Returns "-", the string delimiter to separate IDs.

◆ operator!=()

bool operator!= ( const UniqueBulbId & rhs ) const

Tests for inequality with another UniqueBulbId, specifically returning the opposite of operator==().

◆ operator==()

bool operator== ( const UniqueBulbId & rhs ) const

Tests for equality with another UniqueBulbId.

◆ traffic_light_id()

const TrafficLight::Id traffic_light_id ( ) const

Friends And Related Function Documentation

◆ hash_append

void hash_append	(	HashAlgorithm &	hasher,
		const UniqueBulbId &	id
	)

friend

Implements the hash_append concept.

The documentation for this class was generated from the following files: