maliput
UniqueBulbGroupId Class Reference

Detailed Description

Uniquely identifies a bulb group in the Inertial space.

This consists of the concatenation of the ID of the bulb group, and 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()`"

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

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

Inheritance diagram for UniqueBulbGroupId:
[legend]

Public Member Functions

 UniqueBulbGroupId ()
 A default constructor. More...
 
 UniqueBulbGroupId (const TrafficLight::Id &traffic_light_id, const BulbGroup::Id &bulb_group_id)
 Constructs a UniqueBulbGroupId. More...
 
bool operator== (const UniqueBulbGroupId &rhs) const
 Tests for equality with another UniqueBulbGroupId. More...
 
bool operator!= (const UniqueBulbGroupId &rhs) const
 Tests for inequality with another UniqueBulbGroupId, specifically returning the opposite of operator==(). More...
 
TrafficLight::Id traffic_light_id () const
 
BulbGroup::Id bulb_group_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 UniqueBulbGroupId &id) noexcept
 Implements the hash_append generic hashing concept. More...
 

Constructor & Destructor Documentation

◆ UniqueBulbGroupId() [1/2]

A default constructor.

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

◆ UniqueBulbGroupId() [2/2]

UniqueBulbGroupId ( const TrafficLight::Id traffic_light_id,
const BulbGroup::Id bulb_group_id 
)

Constructs a UniqueBulbGroupId.

Member Function Documentation

◆ bulb_group_id()

BulbGroup::Id bulb_group_id ( ) const

◆ delimiter()

const std::string delimiter ( )
static

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

◆ operator!=()

bool operator!= ( const UniqueBulbGroupId rhs) const

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

◆ operator==()

bool operator== ( const UniqueBulbGroupId rhs) const

Tests for equality with another UniqueBulbGroupId.

◆ traffic_light_id()

TrafficLight::Id traffic_light_id ( ) const

Friends And Related Function Documentation

◆ hash_append

void hash_append ( HashAlgorithm &  hasher,
const UniqueBulbGroupId id 
)
friend

Implements the hash_append generic hashing concept.


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