UniqueId Class Reference

Detailed Description

Represents an unique identifier.

Uniqueness is not guaranteed by this class. ID providers will be responsible of guaranteeing uniqueness across the specified domain.

#include <include/maliput/api/unique_id.h>

Inheritance diagram for UniqueId:

Public Member Functions
	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...

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

Constructor & Destructor Documentation

UniqueId()

UniqueId ( const std::string &  string )

explicit

Constructs a UniqueId from the given string.

Exceptions

maliput::common::assertion_error

if string is empty.

Member Function Documentation

MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN()

MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN

(

UniqueId

)

operator!=()

bool operator!=

(

const UniqueId &

rhs

)

const

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

operator==()

bool operator==

(

const UniqueId &

rhs

)

const

Tests for equality with another UniqueId.

string()

const std::string& string

(

)

const

Returns the string representation of the UniqueId.

Friends And Related Function Documentation

hash_append

void hash_append ( HashAlgorithm &  hasher, const UniqueId &  item  )

friend

Implements the hash_append concept.

---

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

• unique_id.h