empty Map-like data structure. More...

#include <EmptyMap.hpp>

Public Member Functions
	EmptyMap () noexcept=default

virtual	~EmptyMap () noexcept=default
	Virtual destructor. More...

	EmptyMap (const EmptyMap &) noexcept=default
	Copy deleted. More...

	EmptyMap (EmptyMap &&) noexcept=default
	Movement allowed. More...

EmptyMap &	operator= (const EmptyMap &) noexcept=default
	Copy operator allowed. More...

EmptyMap &	operator= (EmptyMap &&) noexcept=default
	Movement operator default due private references. More...

V *	add (const K &) noexcept override
	Add element. More...

bool	add (const K &, const V &) noexcept override
	Add element. More...

V *	find (const K &) noexcept override
	Find value of given key. More...

V *	at (uint32_t) noexcept override
	Get element of given index. More...

const V *	const_at (uint32_t) const noexcept override
	Get element of given index. More...

const K *	key_at (uint32_t) const noexcept override
	Get key on given index. More...

memory::Pair< const K , V >	key_value_at (uint32_t) noexcept override
	Get key and value on given index. More...

void	remove (const K &) noexcept override
	Remove element of given key. More...

uint32_t	size () const noexcept override
	Used size of the container. More...

uint32_t	capacity () const noexcept override
	Max capacity of the container. More...

void	clear () noexcept override
	Remove all elements from the container. More...

Additional Inherited Members
Protected Member Functions inherited from eprosima::safedds::memory::IMap< K, V >
	~IMap () noexcept=default
	Protected destructor ownership defined on creation. More...

	IMap () noexcept=default
	Default creation. More...

	IMap (const IMap &) noexcept=delete
	Copy deleted. More...

	IMap (IMap &&) noexcept=delete
	Movement deleted. More...

IMap &	operator= (const IMap &) noexcept=delete
	Copy operator deleted. More...

IMap &	operator= (IMap &&) noexcept=delete
	Movement operator deleted. More...

Protected Member Functions inherited from eprosima::safedds::memory::IMapBase< K, V >
	~IMapBase () noexcept=default
	Protected destructor ownership defined on creation. More...

	IMapBase () noexcept=default
	Default creation. More...

	IMapBase (const IMapBase &) noexcept=delete
	Copy deleted. More...

	IMapBase (IMapBase &&) noexcept=delete
	Movement deleted. More...

IMapBase &	operator= (const IMapBase &) noexcept=delete
	Copy operator deleted. More...

IMapBase &	operator= (IMapBase &&) noexcept=delete
	Movement operator deleted. More...

Protected Member Functions inherited from eprosima::safedds::memory::IContainerBase
	~IContainerBase () noexcept=default
	Protected destructor ownership defined on creation. More...

	IContainerBase () noexcept=default
	Default creation. More...

	IContainerBase (const IContainerBase &) noexcept=default
	Copy allowed. More...

	IContainerBase (IContainerBase &&) noexcept=default
	Movement allowed. More...

IContainerBase &	operator= (const IContainerBase &) noexcept=default
	Copy operator deleted. More...

IContainerBase &	operator= (IContainerBase &&) noexcept=default
	Movement operator deleted. More...

Detailed Description

template<typename K, typename V>
class eprosima::safedds::memory::container::EmptyMap< K, V >

empty Map-like data structure.

Constructor & Destructor Documentation

◆ EmptyMap() [1/3]

template<typename K , typename V >

eprosima::safedds::memory::container::EmptyMap< K, V >::EmptyMap ( )

defaultnoexcept

◆ ~EmptyMap()

template<typename K , typename V >

virtual eprosima::safedds::memory::container::EmptyMap< K, V >::~EmptyMap ( )

virtualdefaultnoexcept

Virtual destructor.

◆ EmptyMap() [2/3]

template<typename K , typename V >

eprosima::safedds::memory::container::EmptyMap< K, V >::EmptyMap ( const EmptyMap< K, V > & )

defaultnoexcept

Copy deleted.

◆ EmptyMap() [3/3]

template<typename K , typename V >

eprosima::safedds::memory::container::EmptyMap< K, V >::EmptyMap ( EmptyMap< K, V > && )

defaultnoexcept

Movement allowed.

Member Function Documentation

◆ add() [1/2]

template<typename K , typename V >

V* eprosima::safedds::memory::container::EmptyMap< K, V >::add ( const K & key )

inlineoverridevirtualnoexcept

Add element.

Warning: this method may not ensure initialization of the element.

Parameters

[in] key key.

Returns: Pointer to V in memory, nullptr if failure.

Implements eprosima::safedds::memory::IMap< K, V >.

◆ add() [2/2]

template<typename K , typename V >

bool eprosima::safedds::memory::container::EmptyMap< K, V >::add	(	const K &	key,
		const V &	value
	)

inlineoverridevirtualnoexcept

Add element.

Parameters

[in]	key	key.
[in]	value	value.

Returns: true if added.

Implements eprosima::safedds::memory::IMap< K, V >.

◆ at()

template<typename K , typename V >

V* eprosima::safedds::memory::container::EmptyMap< K, V >::at ( uint32_t pos )

inlineoverridevirtualnoexcept

Get element of given index.

Parameters

pos	position index.

Returns: pointer to value.

Implements eprosima::safedds::memory::IMapBase< K, V >.

◆ capacity()

template<typename K , typename V >

uint32_t eprosima::safedds::memory::container::EmptyMap< K, V >::capacity ( ) const

inlineoverridevirtualnoexcept

Max capacity of the container.

Returns: uint32_t.

Implements eprosima::safedds::memory::IContainerBase.

◆ clear()

template<typename K , typename V >

void eprosima::safedds::memory::container::EmptyMap< K, V >::clear ( )

inlineoverridevirtualnoexcept

Remove all elements from the container.

Implements eprosima::safedds::memory::IContainerBase.

◆ const_at()

template<typename K , typename V >

const V* eprosima::safedds::memory::container::EmptyMap< K, V >::const_at ( uint32_t pos ) const

inlineoverridevirtualnoexcept

Get element of given index.

Parameters

pos	position index.

Returns: pointer to value.

Implements eprosima::safedds::memory::IMapBase< K, V >.

◆ find()

template<typename K , typename V >

V* eprosima::safedds::memory::container::EmptyMap< K, V >::find ( const K & key )

inlineoverridevirtualnoexcept

Find value of given key.

Parameters

[in] key key.

Returns: Pointer to v.

Implements eprosima::safedds::memory::IMapBase< K, V >.

◆ key_at()

template<typename K , typename V >

const K* eprosima::safedds::memory::container::EmptyMap< K, V >::key_at ( uint32_t pos ) const

inlineoverridevirtualnoexcept

Get key on given index.

Parameters

pos	position index.

Returns: pointer to key.

Implements eprosima::safedds::memory::IMapBase< K, V >.

◆ key_value_at()

template<typename K , typename V >

memory::Pair<const K*, V*> eprosima::safedds::memory::container::EmptyMap< K, V >::key_value_at ( uint32_t pos )

inlineoverridevirtualnoexcept

Get key and value on given index.

Parameters

pos	position index.

Returns: pair with pointer to key and pointer to value.

Implements eprosima::safedds::memory::IMapBase< K, V >.

◆ operator=() [1/2]

template<typename K , typename V >

EmptyMap& eprosima::safedds::memory::container::EmptyMap< K, V >::operator= ( const EmptyMap< K, V > & )

defaultnoexcept

Copy operator allowed.

Returns: EmptyMap&.

◆ operator=() [2/2]

template<typename K , typename V >

EmptyMap& eprosima::safedds::memory::container::EmptyMap< K, V >::operator= ( EmptyMap< K, V > && )

defaultnoexcept

Movement operator default due private references.

Returns: EmptyMap&.

◆ remove()

template<typename K , typename V >

void eprosima::safedds::memory::container::EmptyMap< K, V >::remove ( const K & key )

inlineoverridevirtualnoexcept

Remove element of given key.

Parameters

[in] key key.

Implements eprosima::safedds::memory::IMapBase< K, V >.

◆ size()

template<typename K , typename V >

uint32_t eprosima::safedds::memory::container::EmptyMap< K, V >::size ( ) const

inlineoverridevirtualnoexcept

Used size of the container.

Returns: uint32_t.

Implements eprosima::safedds::memory::IContainerBase.

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

build/docs/user_manual/main/tmp/include/safedds/memory/container/EmptyMap.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename K, typename V> class eprosima::safedds::memory::container::EmptyMap< K, V >

Constructor & Destructor Documentation

◆ EmptyMap() [1/3]

◆ ~EmptyMap()

◆ EmptyMap() [2/3]

◆ EmptyMap() [3/3]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ at()

◆ capacity()

◆ clear()

◆ const_at()

◆ find()

◆ key_at()

◆ key_value_at()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ remove()

◆ size()

template<typename K, typename V>
class eprosima::safedds::memory::container::EmptyMap< K, V >