Map-like data structure of references. More...

#include <IReferenceMap.hpp>

Public Member Functions
virtual V *	find (const K &key) noexcept=0
	Find value of given key. More...

virtual bool	add (const K &key, V &value) noexcept=0
	Add element. More...

virtual bool	add (const K &key, V *value) noexcept=0
	Move element. More...

virtual V *	at (uint32_t pos) noexcept=0
	Get element of given index. More...

virtual const V *	const_at (uint32_t pos) const noexcept=0
	Get element of given index. More...

Public Member Functions inherited from eprosima::safedds::memory::IMapBase< K >
virtual void	remove (const K &key) noexcept=0
	Remove element of given key. More...

virtual const K *	key_at (uint32_t pos) const noexcept=0
	Get key on given index. More...

Public Member Functions inherited from eprosima::safedds::memory::IContainerBase
virtual uint32_t	capacity () const noexcept=0
	Max capacity of the container. More...

virtual uint32_t	size () const noexcept=0
	Used size of the container. More...

virtual void	clear () noexcept=0
	Remove all elements from the container. More...

Protected Member Functions
	~IReferenceMap () noexcept=default
	Protected destructor ownership defined on creation. More...

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

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

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

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

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

Protected Member Functions inherited from eprosima::safedds::memory::IMapBase< K >
	~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>
interface eprosima::safedds::memory::IReferenceMap< K, V >

Map-like data structure of references.

Constructor & Destructor Documentation

◆ ~IReferenceMap()

template<typename K , typename V >

eprosima::safedds::memory::IReferenceMap< K, V >::~IReferenceMap ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

◆ IReferenceMap() [1/3]

template<typename K , typename V >

eprosima::safedds::memory::IReferenceMap< K, V >::IReferenceMap ( )

protecteddefaultnoexcept

Default creation.

◆ IReferenceMap() [2/3]

template<typename K , typename V >

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

protecteddeletenoexcept

Copy deleted.

◆ IReferenceMap() [3/3]

template<typename K , typename V >

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

protecteddeletenoexcept

Movement deleted.

Member Function Documentation

◆ add() [1/2]

template<typename K , typename V >

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

pure virtualnoexcept

Add element.

Parameters

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

Returns: true if added.

Implemented in eprosima::safedds::memory::container::StaticReferenceMap< TYPE_NAME, const eprosima::safedds::dds::TypeSupport, MaxLocalTopics >, eprosima::safedds::memory::container::StaticReferenceMap< K, V, N >, and eprosima::safedds::memory::container::PreallocReferenceMap< K, V >.

◆ add() [2/2]

template<typename K , typename V >

virtual bool eprosima::safedds::memory::IReferenceMap< K, V >::add	(	const K &	key,
		V *	value
	)

pure virtualnoexcept

Move element.

Parameters

[in]	key	key.
[in]	value	pointer to value.

Returns: true if added.

Implemented in eprosima::safedds::memory::container::StaticReferenceMap< TYPE_NAME, const eprosima::safedds::dds::TypeSupport, MaxLocalTopics >, eprosima::safedds::memory::container::StaticReferenceMap< K, V, N >, and eprosima::safedds::memory::container::PreallocReferenceMap< K, V >.

◆ at()

template<typename K , typename V >

virtual V* eprosima::safedds::memory::IReferenceMap< K, V >::at ( uint32_t pos )

pure virtualnoexcept

Get element of given index.

Parameters

pos	position index.

Returns: pointer to value.

Implemented in eprosima::safedds::memory::container::StaticReferenceMap< K, V, N >, eprosima::safedds::memory::container::StaticReferenceMap< TYPE_NAME, const eprosima::safedds::dds::TypeSupport, MaxLocalTopics >, and eprosima::safedds::memory::container::PreallocReferenceMap< K, V >.

◆ const_at()

template<typename K , typename V >

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

pure virtualnoexcept

Get element of given index.

Parameters

pos	position index.

Returns: pointer to value.

Implemented in eprosima::safedds::memory::container::StaticReferenceMap< K, V, N >, eprosima::safedds::memory::container::StaticReferenceMap< TYPE_NAME, const eprosima::safedds::dds::TypeSupport, MaxLocalTopics >, and eprosima::safedds::memory::container::PreallocReferenceMap< K, V >.

◆ find()

template<typename K , typename V >

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

pure virtualnoexcept

Find value of given key.

Parameters

[in] key key.

Returns: Pointer to v.

Implemented in eprosima::safedds::memory::container::StaticReferenceMap< TYPE_NAME, const eprosima::safedds::dds::TypeSupport, MaxLocalTopics >, eprosima::safedds::memory::container::StaticReferenceMap< K, V, N >, and eprosima::safedds::memory::container::PreallocReferenceMap< K, V >.

◆ operator=() [1/2]

template<typename K , typename V >

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

protecteddeletenoexcept

Copy operator deleted.

Returns: IReferenceMap&.

◆ operator=() [2/2]

template<typename K , typename V >

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

protecteddeletenoexcept

Movement operator deleted.

Returns: IReferenceMap&.

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

build/docs/user_manual/v2.0.0/tmp/include/safedds/memory/IReferenceMap.hpp

Public Member Functions

Protected Member Functions

Detailed Description

template<typename K, typename V> interface eprosima::safedds::memory::IReferenceMap< K, V >

Constructor & Destructor Documentation

◆ ~IReferenceMap()

◆ IReferenceMap() [1/3]

◆ IReferenceMap() [2/3]

◆ IReferenceMap() [3/3]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ at()

◆ const_at()

◆ find()

◆ operator=() [1/2]

◆ operator=() [2/2]

template<typename K, typename V>
interface eprosima::safedds::memory::IReferenceMap< K, V >