Base Framework
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
BitSet::BitSetReadEnumerator Class Reference

Non-modifying enumerator of elements of a bit set. More...

#include <base/collection/BitSet.h>

Inherits BitSet::BitSetEnumerator< ReadEnumeratorTraits >.

Public Member Functions

 BitSetReadEnumerator (const BitSetReadEnumerator &copy) noexcept
 
bool hasNext () const noexcept
 
EnumReference next ()
 
bool operator== (const BitSetReadEnumerator &compare) const noexcept
 
bool operator!= (const BitSetReadEnumerator &compare) const noexcept
 
- Public Member Functions inherited from BitSet::BitSetEnumerator
 BitSetEnumerator (const BitSetEnumerator &copy) noexcept
 
bool operator== (const BitSetEnumerator &compare) const noexcept
 
bool operator!= (const BitSetEnumerator &compare) const noexcept
 
- Public Member Functions inherited from Enumerator< TRAITS >
virtual ~Enumerator ()
 

Protected Types

typedef Enumerator< ReadEnumeratorTraits >::Value Value
 
typedef Enumerator< ReadEnumeratorTraits >::Reference EnumReference
 
typedef Enumerator< ReadEnumeratorTraits >::Pointer Pointer
 
- Protected Types inherited from BitSet::BitSetEnumerator
typedef Enumerator< EnumeratorTraits >::Value Value
 
typedef Enumerator< EnumeratorTraits >::Reference Reference
 
typedef Enumerator< EnumeratorTraits >::Pointer Pointer
 

Protected Member Functions

 BitSetReadEnumerator (const unsigned long *_word, MemorySize _count) noexcept
 
- Protected Member Functions inherited from BitSet::BitSetEnumerator
 BitSetEnumerator (unsigned long *_word, unsigned int _count) noexcept
 

Protected Attributes

const unsigned long * word = nullptr
 
MemorySize count = 0
 
EnumReference current
 
- Protected Attributes inherited from BitSet::BitSetEnumerator
unsigned long * word = nullptr
 
unsigned int count = 0
 
Reference current
 

Additional Inherited Members

- Public Types inherited from Enumerator< TRAITS >
typedef TRAITS::Value Value
 
typedef TRAITS::Distance Distance
 
typedef TRAITS::Reference Reference
 
typedef TRAITS::Pointer Pointer
 

Detailed Description

Non-modifying enumerator of elements of a bit set.

Enumerator of elements of a bit set.

Version
1.0
Examples
testsuite/BitSet.cpp.

Constructor & Destructor Documentation

◆ BitSetReadEnumerator() [1/2]

BitSet::BitSetReadEnumerator::BitSetReadEnumerator ( const unsigned long *  _word,
MemorySize  _count 
)
inlineexplicitprotectednoexcept

Initializes an enumeration of all the elements of a bit set.

Parameters
wordSpecifies the beginning of the enumeration.
countThe number of bits in the set.

◆ BitSetReadEnumerator() [2/2]

BitSet::BitSetReadEnumerator::BitSetReadEnumerator ( const BitSetReadEnumerator copy)
inlinenoexcept

Initializes enumeration from other enumeration.

Member Function Documentation

◆ hasNext()

bool BitSet::BitSetReadEnumerator::hasNext ( ) const
inlinevirtualnoexcept

Returns true if the enumeration still contains elements.

Reimplemented from BitSet::BitSetEnumerator.

Examples
testsuite/BitSet.cpp.

◆ next()

EnumReference BitSet::BitSetReadEnumerator::next ( )
inlinevirtual

Returns the next element and advances the position of this enumeration.

Reimplemented from BitSet::BitSetEnumerator.

Examples
testsuite/BitSet.cpp.

◆ operator!=()

bool BitSet::BitSetReadEnumerator::operator!= ( const BitSetReadEnumerator compare) const
inlinenoexcept

Returns true if the enumerations aren't pointing to the same position.

◆ operator==()

bool BitSet::BitSetReadEnumerator::operator== ( const BitSetReadEnumerator compare) const
inlinenoexcept

Returns true if the enumerations are pointing to the same position.

Member Data Documentation

◆ count

MemorySize BitSet::BitSetReadEnumerator::count = 0
protected

The number of bits left.

◆ current

EnumReference BitSet::BitSetReadEnumerator::current
protected

Current position.

◆ word

const unsigned long* BitSet::BitSetReadEnumerator::word = nullptr
protected

The current position in the enumeration.