eprosima::safedds::memory::IBaseBitmapSet< T > Interface Template Reference

Interface class with the common const methods of Bitmap. More...

#include <IBaseBitmapSet.hpp>

Public Member Functions
virtual Bitmap< T >	get_bitmap () const noexcept=0
	Copy the Bitmap contents of this map into another Bitmap instance. More...
virtual T	base () const noexcept=0
	Get base of the bitmap. More...
virtual bool	empty () const noexcept=0
	Checks if the bitmap contains setted values. More...
virtual uint32_t	count () const noexcept=0
	Returns the number of values set in the bitmap. More...
virtual ReturnCode	max (T &result) const noexcept=0
	Returns the highest value set in the bitmap. More...
virtual ReturnCode	min (T &result) const noexcept=0
	Returns the lowest value set in the bitmap. More...
virtual ReturnCode	min_max (T &min_value, T &max_value) const noexcept=0
	Returns the lowest and highest value set in the bitmap. More...
virtual bool	is_set (const T &item) const noexcept=0
	Checks if an element is present in the bitmap. More...

Protected Member Functions
	~IBaseBitmapSet () noexcept=default
	Protected destructor ownership defined on creation. More...
	IBaseBitmapSet () noexcept=default
	Default creation. More...
	IBaseBitmapSet (const IBaseBitmapSet &) noexcept=default
	Copy allowed. More...
	IBaseBitmapSet (IBaseBitmapSet &&) noexcept=default
	Movement allowed. More...
IBaseBitmapSet &	operator= (const IBaseBitmapSet &) noexcept=default
	Copy operator allowed. More...
IBaseBitmapSet &	operator= (IBaseBitmapSet &&) noexcept=default
	Movement operator allowed. More...

Detailed Description

template<class T>
interface eprosima::safedds::memory::IBaseBitmapSet< T >

Interface class with the common const methods of Bitmap.

Constructor & Destructor Documentation

~IBaseBitmapSet()

template<class T >

eprosima::safedds::memory::IBaseBitmapSet< T >::~IBaseBitmapSet ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

IBaseBitmapSet() [1/3]

template<class T >

eprosima::safedds::memory::IBaseBitmapSet< T >::IBaseBitmapSet ( )

protecteddefaultnoexcept

Default creation.

IBaseBitmapSet() [2/3]

template<class T >

eprosima::safedds::memory::IBaseBitmapSet< T >::IBaseBitmapSet ( const IBaseBitmapSet< T > &  )

protecteddefaultnoexcept

Copy allowed.

IBaseBitmapSet() [3/3]

template<class T >

eprosima::safedds::memory::IBaseBitmapSet< T >::IBaseBitmapSet ( IBaseBitmapSet< T > &&  )

protecteddefaultnoexcept

Movement allowed.

Member Function Documentation

base()

template<class T >

virtual T eprosima::safedds::memory::IBaseBitmapSet< T >::base ( ) const

pure virtualnoexcept

Get base of the bitmap.

Returns

a copy of the bitmap base.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

count()

template<class T >

virtual uint32_t eprosima::safedds::memory::IBaseBitmapSet< T >::count ( ) const

pure virtualnoexcept

Returns the number of values set in the bitmap.

Returns

Number of values set in the bitmap.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

empty()

template<class T >

virtual bool eprosima::safedds::memory::IBaseBitmapSet< T >::empty ( ) const

pure virtualnoexcept

Checks if the bitmap contains setted values.

Returns

True if no values are set, false otherwise.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

get_bitmap()

template<class T >

virtual Bitmap<T> eprosima::safedds::memory::IBaseBitmapSet< T >::get_bitmap ( ) const

pure virtualnoexcept

Copy the Bitmap contents of this map into another Bitmap instance.

Returns

A copy of the Bitmap.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

is_set()

template<class T >

virtual bool eprosima::safedds::memory::IBaseBitmapSet< T >::is_set ( const T &  item ) const

pure virtualnoexcept

Checks if an element is present in the bitmap.

Parameters

item	Value to be checked.

Returns

true if the item is present in the bitmap, false otherwise.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

max()

template<class T >

virtual ReturnCode eprosima::safedds::memory::IBaseBitmapSet< T >::max ( T &  result ) const

pure virtualnoexcept

Returns the highest value set in the bitmap.

Parameters

[out]

result

Highest value set in the bitmap on successful return

Returns

ReturnCode::OK if the maximum value is found, ReturnCode::CONTAINER_BITMAP_IS_EMPTY otherwise.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

min()

template<class T >

virtual ReturnCode eprosima::safedds::memory::IBaseBitmapSet< T >::min ( T &  result ) const

pure virtualnoexcept

Returns the lowest value set in the bitmap.

Parameters

[out]

result

Lowest value set in the bitmap on successful return

Returns

ReturnCode::OK if the minimum value is found, ReturnCode::CONTAINER_BITMAP_IS_EMPTY otherwise.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

min_max()

template<class T >

virtual ReturnCode eprosima::safedds::memory::IBaseBitmapSet< T >::min_max ( T &  min_value, T &  max_value  ) const

pure virtualnoexcept

Returns the lowest and highest value set in the bitmap.

Parameters

[out]	min_value	Lowest value set in the bitmap on successful return
[out]	max_value	Highest value set in the bitmap on successful return

Returns

ReturnCode::OK if the minimum and maximum values are found, ReturnCode::CONTAINER_BITMAP_IS_EMPTY otherwise.

Implemented in eprosima::safedds::memory::container::BitmapSet< T, BitmapHelper, NBITS >.

operator=() [1/2]

template<class T >

IBaseBitmapSet& eprosima::safedds::memory::IBaseBitmapSet< T >::operator= ( const IBaseBitmapSet< T > &  )

protecteddefaultnoexcept

Copy operator allowed.

Returns

IBaseBitmapSet&.

operator=() [2/2]

template<class T >

IBaseBitmapSet& eprosima::safedds::memory::IBaseBitmapSet< T >::operator= ( IBaseBitmapSet< T > &&  )

protecteddefaultnoexcept

Movement operator allowed.

Returns

IBaseBitmapSet&.

---

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

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