Basic Primitive class for all primitives of lanelet2. More...

#include <Primitive.h>

Public Types
using	DataType = Data

Public Member Functions
const Attribute &	attribute (const std::string &name) const
	retrieve an attribute More...

const Attribute &	attribute (AttributeName name) const
	retrieve an attribute (enum version) More...

template<typename T >
T	attributeOr (const std::string &name, T defaultVal) const noexcept
	retrieve an attribute (string version) More...

template<typename T >
T	attributeOr (AttributeName name, T defaultVal) const
	retrieve an attribute (enum version) More...

const AttributeMap &	attributes () const
	get the attributes of this primitive More...

const std::shared_ptr< const Data > &	constData () const
	get the internal data of this primitive More...

	ConstPrimitive (const std::shared_ptr< const Data > &data)
	Construct from a pointer to the data. More...

bool	hasAttribute (const std::string &name) const noexcept
	check whether this primitive has a specific attribute More...

bool	hasAttribute (AttributeName name) const noexcept
	check for an attribute (enum version) More...

Id	id () const noexcept
	get the unique id of this primitive More...

bool	operator!= (const ConstPrimitive &rhs) const

bool	operator== (const ConstPrimitive &rhs) const

Static Public Attributes
static constexpr bool	IsConst = true

Protected Member Functions
	ConstPrimitive (ConstPrimitive &&rhs) noexcept=default

	ConstPrimitive (const ConstPrimitive &rhs)=default

ConstPrimitive &	operator= (ConstPrimitive &&rhs) noexcept=default

ConstPrimitive &	operator= (const ConstPrimitive &rhs)=default

	~ConstPrimitive () noexcept=default

Private Attributes
std::shared_ptr< const Data >	constData_
	the data this primitive holds More...

Detailed Description

template<typename Data>
class lanelet::ConstPrimitive< Data >

Basic Primitive class for all primitives of lanelet2.

Template Parameters

Data	Type of the data object that this ConstPrimitive holds

Definition at line 70 of file Primitive.h.

Member Typedef Documentation

◆ DataType

template<typename Data>

using lanelet::ConstPrimitive< Data >::DataType = Data

Definition at line 72 of file Primitive.h.

Constructor & Destructor Documentation

◆ ConstPrimitive() [1/3]

template<typename Data>

lanelet::ConstPrimitive< Data >::ConstPrimitive ( const std::shared_ptr< const Data > & data )

inlineexplicit

Construct from a pointer to the data.

Parameters

data	internal data for this primitive. Must not be null.

Definition at line 78 of file Primitive.h.

◆ ConstPrimitive() [2/3]

template<typename Data>

lanelet::ConstPrimitive< Data >::ConstPrimitive ( ConstPrimitive< Data > && rhs )

protecteddefaultnoexcept

◆ ConstPrimitive() [3/3]

template<typename Data>

lanelet::ConstPrimitive< Data >::ConstPrimitive ( const ConstPrimitive< Data > & rhs )

protecteddefault

◆ ~ConstPrimitive()

template<typename Data>

lanelet::ConstPrimitive< Data >::~ConstPrimitive ( )

protecteddefaultnoexcept

Member Function Documentation

◆ attribute() [1/2]

template<typename Data>

const Attribute& lanelet::ConstPrimitive< Data >::attribute ( const std::string & name ) const

inline

retrieve an attribute

Exceptions

NoSuchAttributeError if it does not exist

Definition at line 113 of file Primitive.h.

◆ attribute() [2/2]

template<typename Data>

const Attribute& lanelet::ConstPrimitive< Data >::attribute ( AttributeName name ) const

inline

retrieve an attribute (enum version)

Exceptions

NoSuchAttributeError if it does not exist

Definition at line 125 of file Primitive.h.

◆ attributeOr() [1/2]

template<typename Data>

template<typename T >

T lanelet::ConstPrimitive< Data >::attributeOr	(	const std::string &	name,
		T	defaultVal
	)		const

inlinenoexcept

retrieve an attribute (string version)

Parameters

name	name of the attribute
defaultVal	value returned if not existing

Template Parameters

T	return type (must be one of Attribute::as<T>())

T can also be an Optional so that you get an empty optional if the value did not exist or could not be converted.

Definition at line 143 of file Primitive.h.

◆ attributeOr() [2/2]

template<typename Data>

template<typename T >

T lanelet::ConstPrimitive< Data >::attributeOr	(	AttributeName	name,
		T	defaultVal
	)		const

inline

retrieve an attribute (enum version)

Parameters

name	name of the attribute
defaultVal	value returned if not existing

Template Parameters

T	return type (must be one of Attribute::as<T>())

T can also be an Optional so that you get an empty optional if the value did not exist or could not be converted.

Definition at line 165 of file Primitive.h.

◆ attributes()

template<typename Data>

const AttributeMap& lanelet::ConstPrimitive< Data >::attributes ( ) const

inline

get the attributes of this primitive

Definition at line 89 of file Primitive.h.

◆ constData()

template<typename Data>

const std::shared_ptr<const Data>& lanelet::ConstPrimitive< Data >::constData ( ) const

inline

get the internal data of this primitive

Definition at line 178 of file Primitive.h.

◆ hasAttribute() [1/2]

template<typename Data>

bool lanelet::ConstPrimitive< Data >::hasAttribute ( const std::string & name ) const

inlinenoexcept

check whether this primitive has a specific attribute

Definition at line 99 of file Primitive.h.

◆ hasAttribute() [2/2]

template<typename Data>

bool lanelet::ConstPrimitive< Data >::hasAttribute ( AttributeName name ) const

inlinenoexcept

check for an attribute (enum version)

The enum version provides a much more efficient access to the data. It is basically the difference between access via a vector and a std::map lookup. However, this kind of access only works for the most common attribte names.

Definition at line 107 of file Primitive.h.

◆ id()

template<typename Data>

Id lanelet::ConstPrimitive< Data >::id ( ) const

inlinenoexcept

get the unique id of this primitive

Keep in mind that the Id can also be InvalId, if the element is a temporary structure that is not a part of the map.

Definition at line 96 of file Primitive.h.

◆ operator!=()

template<typename Data>

bool lanelet::ConstPrimitive< Data >::operator!= ( const ConstPrimitive< Data > & rhs ) const

inline

Definition at line 86 of file Primitive.h.

◆ operator=() [1/2]

template<typename Data>

ConstPrimitive& lanelet::ConstPrimitive< Data >::operator= ( ConstPrimitive< Data > && rhs )

protecteddefaultnoexcept

◆ operator=() [2/2]

template<typename Data>

ConstPrimitive& lanelet::ConstPrimitive< Data >::operator= ( const ConstPrimitive< Data > & rhs )

protecteddefault

◆ operator==()

template<typename Data>

bool lanelet::ConstPrimitive< Data >::operator== ( const ConstPrimitive< Data > & rhs ) const

inline

Definition at line 85 of file Primitive.h.

Member Data Documentation

◆ constData_

template<typename Data>

std::shared_ptr<const Data> lanelet::ConstPrimitive< Data >::constData_

private

the data this primitive holds

Definition at line 189 of file Primitive.h.

◆ IsConst

template<typename Data>

constexpr bool lanelet::ConstPrimitive< Data >::IsConst = true

static

Definition at line 73 of file Primitive.h.

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

Primitive.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

template<typename Data> class lanelet::ConstPrimitive< Data >

Member Typedef Documentation

◆ DataType

Constructor & Destructor Documentation

◆ ConstPrimitive() [1/3]

◆ ConstPrimitive() [2/3]

◆ ConstPrimitive() [3/3]

◆ ~ConstPrimitive()

Member Function Documentation

◆ attribute() [1/2]

◆ attribute() [2/2]

◆ attributeOr() [1/2]

◆ attributeOr() [2/2]

◆ attributes()

◆ constData()

◆ hasAttribute() [1/2]

◆ hasAttribute() [2/2]

◆ id()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Member Data Documentation

◆ constData_

◆ IsConst

template<typename Data>
class lanelet::ConstPrimitive< Data >