BITSET_DEQUE Class Reference

#include <bitsetd.h>

List of all members.

Public Member Functions
	BITSET_DEQUE ()
	BITSET_DEQUE (const BITSET_DEQUE &rhs)
	~BITSET_DEQUE ()
BITSET_DEQUE &	operator= (const BITSET_DEQUE &rhs)
ITERATOR	Begin (bool value=true) const
void	Clear (UINT32 posn)
void	ClearAll ()
void	ClearRange (UINT32 min, UINT32 max)
void	CopyBit (UINT32 DestPosn, UINT32 SourcePosn)
ITERATOR	End () const
void	Free ()
bool	GetBit (UINT32 posn) const
INT32	GetBitArray (UINT8 *&array) const
UINT32	GetNumEntries () const
bool	GetRange (UINT32 StartPosn, UINT32 MaxEnd, UINT32 &EndPosn) const
bool	HasEntries () const
void	Invert (UINT32 posn)
void	InvertAll ()
void	InvertRange (UINT32 min, UINT32 max)
ERRVALUE	Resize (UINT32 NumEntries)
void	Set (UINT32 posn)
void	SetAll ()
void	SetBit (UINT32 posn, bool value)
void	SetRange (UINT32 min, UINT32 max)

---

Constructor & Destructor Documentation

BITSET_DEQUE::BITSET_DEQUE (   )

BITSET_DEQUE::BITSET_DEQUE (  const BITSET_DEQUE &  rhs  )

BITSET_DEQUE::~BITSET_DEQUE (   )

---

Member Function Documentation

ITERATOR BITSET_DEQUE::Begin (  bool  value = true  )  const

Initialize iterator with first set or unset item in the bit set. Returns iterator to first set entry, otherwise the last+1 item if no matching item. Parameters: value  Value to iterate through

void BITSET_DEQUE::Clear (  UINT32  posn  )

Clear value at specified position.

void BITSET_DEQUE::ClearAll (   )

Clear bit array with false. Makes all the entries in the bit set 'false'.

void BITSET_DEQUE::ClearRange (  UINT32  min, UINT32  max )

Set range of entries to "false".

void BITSET_DEQUE::CopyBit (  UINT32  DestPosn, UINT32  SourcePosn )

Transfer value from source to dest entry. Replaces putbit(set, DestPosn, getbit(set, SourcePosn)). Parameters: DestPosn  where setting goes to SourcePosn  where setting comes from

ITERATOR BITSET_DEQUE::End (   )  const

Initialize iterator with last+1 item in the bit set. Returns iterator to last+1 item

void BITSET_DEQUE::Free (   )

Erase BITSET_DEQUE internals, same as calling destructor.

bool BITSET_DEQUE::GetBit (  UINT32  posn  )  const

Retrieve value at the requested position, true or false. Returns 'false' if the position given is outside the range of the BITSET Parameters: posn  position where value is retrieved from

INT32 BITSET_DEQUE::GetBitArray (  UINT8 *&  array  )  const

Retrieve legacy bit array from 'this' Returns number of items in the array. Parameters: array  Must be freed by the caller

UINT32 BITSET_DEQUE::GetNumEntries (   )  const

Return the number of valid entries.

bool BITSET_DEQUE::GetRange (  UINT32  StartPosn, UINT32  MaxEnd, UINT32 &  EndPosn )  const

Get a range of entries that are set continuously in the bitset. Returns: 'True' if a true range, 'false' if a false range Parameters: StartPosn  Staring position MaxEnd  Maximum ending position EndPosn  Ending position (inclusive) RETURNED

bool BITSET_DEQUE::HasEntries (   )  const

Does bit set have any entries?

void BITSET_DEQUE::Invert (  UINT32  posn  )

Invert value at specified position. Parameters: posn  Position to be inverted

void BITSET_DEQUE::InvertAll (   )

Invert all entries in bit set.

void BITSET_DEQUE::InvertRange (  UINT32  min, UINT32  max )

Set range of entries to inverse.

BITSET_DEQUE& BITSET_DEQUE::operator= (  const BITSET_DEQUE &  rhs  )

ERRVALUE BITSET_DEQUE::Resize (  UINT32  NumEntries  )

Resize BITSET to a new number of entries. Parameters: NumEntries  Number of elements to resize to

void BITSET_DEQUE::Set (  UINT32  posn  )

Set a value at the requested position to "true". Does nothing if the position given is outside range. Parameters: posn  Position to set

void BITSET_DEQUE::SetAll (   )

Set all entries to true, opposite of ClearAll(). Turn all bit positions to true.

void BITSET_DEQUE::SetBit (  UINT32  posn, bool  value )

Set a value at the requested position, true or false. Does nothing if the position given is outside range. Parameters: posn  Position where value is set value  Value to be set at position

void BITSET_DEQUE::SetRange (  UINT32  min, UINT32  max )

Set range of entries to "true".

---

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

• mi32/bitsetd.h

---