eprosima::safedds::memory::IMap< K, V > Interface Template Reference

Map-like data structure. More...

#include <IMap.hpp>

Public Member Functions
virtual V *	find (const K &key) noexcept=0
	Find value of given key. More...
virtual V *	add (const K &key) noexcept=0
	Add element. More...
virtual bool	add (const K &key, const V &value) noexcept=0
	Add 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
	~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 >
	~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::IMap< K, V >

Map-like data structure.

Constructor & Destructor Documentation

~IMap()

template<typename K , typename V >

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

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

IMap() [1/3]

template<typename K , typename V >

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

protecteddefaultnoexcept

Default creation.

IMap() [2/3]

template<typename K , typename V >

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

protecteddeletenoexcept

Copy deleted.

IMap() [3/3]

template<typename K , typename V >

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

protecteddeletenoexcept

Movement deleted.

Member Function Documentation

add() [1/2]

template<typename K , typename V >

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

pure virtualnoexcept

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.

Implemented in eprosima::safedds::memory::container::StaticMap< protocol::SequenceNumber, datacentric::SampleInfo::Status, MaxSamplesPerInstance >, eprosima::safedds::memory::container::StaticMap< K, V, N >, eprosima::safedds::memory::container::PreallocMap< K, V >, eprosima::safedds::memory::container::EmptyMap< K, V >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap, MaxLocators >, eprosima::safedds::memory::container::PreallocMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyWriter, MaxRemoteWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyReader, MaxRemoteReaders >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, BaseDataReaderWriterStorage::ActiveWriterInfo, MaxWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, InstanceHandle, MaxRemoteReaders+MaxRemoteWriters >, and eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, WriterState, MaxWritersPerInstance >.

add() [2/2]

template<typename K , typename V >

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

pure virtualnoexcept

Add element.

Parameters

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

Returns

true if added.

Implemented in eprosima::safedds::memory::container::StaticMap< protocol::SequenceNumber, datacentric::SampleInfo::Status, MaxSamplesPerInstance >, eprosima::safedds::memory::container::StaticMap< K, V, N >, eprosima::safedds::memory::container::PreallocMap< K, V >, eprosima::safedds::memory::container::EmptyMap< K, V >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap, MaxLocators >, eprosima::safedds::memory::container::PreallocMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, WriterState, MaxWritersPerInstance >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyWriter, MaxRemoteWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyReader, MaxRemoteReaders >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, InstanceHandle, MaxRemoteReaders+MaxRemoteWriters >, and eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, BaseDataReaderWriterStorage::ActiveWriterInfo, MaxWriters >.

at()

template<typename K , typename V >

virtual V* eprosima::safedds::memory::IMap< 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::EmptyMap< K, V >, eprosima::safedds::memory::container::StaticMap< K, V, N >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyWriter, MaxRemoteWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyReader, MaxRemoteReaders >, eprosima::safedds::memory::container::StaticMap< protocol::SequenceNumber, datacentric::SampleInfo::Status, MaxSamplesPerInstance >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, BaseDataReaderWriterStorage::ActiveWriterInfo, MaxWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap, MaxLocators >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, InstanceHandle, MaxRemoteReaders+MaxRemoteWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, WriterState, MaxWritersPerInstance >, eprosima::safedds::memory::container::PreallocMap< K, V >, and eprosima::safedds::memory::container::PreallocMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap >.

const_at()

template<typename K , typename V >

virtual const V* eprosima::safedds::memory::IMap< 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::EmptyMap< K, V >, eprosima::safedds::memory::container::StaticMap< K, V, N >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyWriter, MaxRemoteWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyReader, MaxRemoteReaders >, eprosima::safedds::memory::container::StaticMap< protocol::SequenceNumber, datacentric::SampleInfo::Status, MaxSamplesPerInstance >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, BaseDataReaderWriterStorage::ActiveWriterInfo, MaxWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap, MaxLocators >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, InstanceHandle, MaxRemoteReaders+MaxRemoteWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, WriterState, MaxWritersPerInstance >, eprosima::safedds::memory::container::PreallocMap< K, V >, and eprosima::safedds::memory::container::PreallocMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap >.

find()

template<typename K , typename V >

virtual V* eprosima::safedds::memory::IMap< 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::StaticMap< protocol::SequenceNumber, datacentric::SampleInfo::Status, MaxSamplesPerInstance >, eprosima::safedds::memory::container::StaticMap< K, V, N >, eprosima::safedds::memory::container::PreallocMap< K, V >, eprosima::safedds::memory::container::EmptyMap< K, V >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap, MaxLocators >, eprosima::safedds::memory::container::PreallocMap< eprosima::safedds::transport::Locator, BaseDomainTransportDispatcher::CreatedParticipantsBitmap >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyWriter, MaxRemoteWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, protocol::rtps::ProxyReader, MaxRemoteReaders >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, BaseDataReaderWriterStorage::ActiveWriterInfo, MaxWriters >, eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, InstanceHandle, MaxRemoteReaders+MaxRemoteWriters >, and eprosima::safedds::memory::container::StaticMap< eprosima::safedds::protocol::GUID, WriterState, MaxWritersPerInstance >.

operator=() [1/2]

template<typename K , typename V >

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

protecteddeletenoexcept

Copy operator deleted.

Returns

IMap&.

operator=() [2/2]

template<typename K , typename V >

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

protecteddeletenoexcept

Movement operator deleted.

Returns

IMap&.

---

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

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