eprosima::safedds::memory::ISet< V > Interface Template Reference

Set-like data structure. More...

#include <ISet.hpp>

Public Member Functions
virtual bool	find (const V &value) noexcept=0
	Check if value is present on set. More...
virtual void	remove (const V &value) noexcept=0
	Remove element from the set. More...
virtual V *	at (uint32_t pos) noexcept=0
	Get element of given index. More...
virtual const V *	at (uint32_t pos) const noexcept=0
	Get element of given index. More...
virtual bool	add (const V &value) noexcept=0
	Push back a new element. 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
	~ISet () noexcept=default
	Protected destructor ownership defined on creation. More...
	ISet () noexcept=default
	Default creation. More...
	ISet (const ISet &) noexcept=default
	Default deleted. More...
	ISet (ISet &&) noexcept=default
	Default deleted. More...
ISet &	operator= (const ISet &) noexcept=default
	Copy operator allowed. More...
ISet &	operator= (ISet &&) noexcept=default
	Movement operator allowed. 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 V>
interface eprosima::safedds::memory::ISet< V >

Set-like data structure.

Constructor & Destructor Documentation

~ISet()

template<typename V >

eprosima::safedds::memory::ISet< V >::~ISet ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

ISet() [1/3]

template<typename V >

eprosima::safedds::memory::ISet< V >::ISet ( )

protecteddefaultnoexcept

Default creation.

ISet() [2/3]

template<typename V >

eprosima::safedds::memory::ISet< V >::ISet ( const ISet< V > &  )

protecteddefaultnoexcept

Default deleted.

ISet() [3/3]

template<typename V >

eprosima::safedds::memory::ISet< V >::ISet ( ISet< V > &&  )

protecteddefaultnoexcept

Default deleted.

Member Function Documentation

add()

template<typename V >

virtual bool eprosima::safedds::memory::ISet< V >::add ( const V &  value )

pure virtualnoexcept

Push back a new element.

Parameters

value

value to add to the list.

Returns

true if OK.

Implemented in eprosima::safedds::memory::container::StaticSet< T, N >, eprosima::safedds::memory::container::PreallocSet< T >, eprosima::safedds::memory::container::StaticSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem, N >, and eprosima::safedds::memory::container::PreallocSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem >.

at() [1/2]

template<typename V >

virtual const V* eprosima::safedds::memory::ISet< V >::at ( uint32_t  pos ) const

pure virtualnoexcept

Get element of given index.

Parameters

pos	position index.

Returns

const pointer to value, nullptr if element not set

Implemented in eprosima::safedds::memory::container::StaticSet< T, N >, eprosima::safedds::memory::container::StaticSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem, N >, eprosima::safedds::memory::container::StaticSet< eprosima::safedds::protocol::GUID, MaxLocalWriters >, eprosima::safedds::memory::container::PreallocSet< T >, and eprosima::safedds::memory::container::PreallocSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem >.

at() [2/2]

template<typename V >

virtual V* eprosima::safedds::memory::ISet< V >::at ( uint32_t  pos )

pure virtualnoexcept

Get element of given index.

Parameters

pos	position index.

Returns

pointer to value, nullptr if element not set

Implemented in eprosima::safedds::memory::container::StaticSet< T, N >, eprosima::safedds::memory::container::StaticSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem, N >, eprosima::safedds::memory::container::StaticSet< eprosima::safedds::protocol::GUID, MaxLocalWriters >, eprosima::safedds::memory::container::PreallocSet< T >, and eprosima::safedds::memory::container::PreallocSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem >.

find()

template<typename V >

virtual bool eprosima::safedds::memory::ISet< V >::find ( const V &  value )

pure virtualnoexcept

Check if value is present on set.

Parameters

value

value to find.

Returns

true if V is on the set.

Implemented in eprosima::safedds::memory::container::StaticSet< T, N >, eprosima::safedds::memory::container::PreallocSet< T >, eprosima::safedds::memory::container::StaticSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem, N >, and eprosima::safedds::memory::container::PreallocSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem >.

operator=() [1/2]

template<typename V >

ISet& eprosima::safedds::memory::ISet< V >::operator= ( const ISet< V > &  )

protecteddefaultnoexcept

Copy operator allowed.

Returns

ISet&.

operator=() [2/2]

template<typename V >

ISet& eprosima::safedds::memory::ISet< V >::operator= ( ISet< V > &&  )

protecteddefaultnoexcept

Movement operator allowed.

Returns

ISet&.

remove()

template<typename V >

virtual void eprosima::safedds::memory::ISet< V >::remove ( const V &  value )

pure virtualnoexcept

Remove element from the set.

Parameters

value

value to remove from set.

Implemented in eprosima::safedds::memory::container::StaticSet< T, N >, eprosima::safedds::memory::container::PreallocSet< T >, eprosima::safedds::memory::container::StaticSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem, N >, and eprosima::safedds::memory::container::PreallocSet< eprosima::safedds::transport::IGUIDLocatorDatabase::GUIDLocatorDatabaseItem >.

---

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

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