BITSET Class Reference

Bit set. More...

#include <mi32/bitset.h>

Inheritance diagram for BITSET:

[legend]List of all members.

Public Member Functions
virtual ERRVALUE	Assign (UINT8 *set, UINT32 NumEntries)
void	Attach (UINT8 *&items, int numitems)
	BITSET (UINT8 *set, UINT32 NumEntries)
	BITSET (const BITSET_UNOWNED &rhs)
	BITSET (const BITSET &rhs)
	BITSET ()
UINT8 *	Detach ()
void	Free ()
BITSET &	operator= (const BITSET_UNOWNED &rhs)
BITSET &	operator= (const BITSET &rhs)
ERRVALUE	Resize (UINT32 NumEntries)
virtual	~BITSET ()

---

Detailed Description

Bit set.

Definition at line 651 of file bitset.h.

---

Constructor & Destructor Documentation

BITSET::BITSET (   )  [inline]

Default constructor. Definition at line 656 of file bitset.h.

BITSET::BITSET (  const BITSET &  rhs  )  [inline]

Copy constructor. Definition at line 661 of file bitset.h.

BITSET::BITSET (  const BITSET_UNOWNED &  rhs  )  [inline]

Construct from BITSET_UNOWNED. Definition at line 670 of file bitset.h.

BITSET::BITSET (  UINT8 *  set, UINT32  NumEntries )  [inline]

Constructor to convert old bit-array's into BITSETs. Parameters: set  Old bit array set NumEntries  Number of items in old bit array, not size in bytes Definition at line 679 of file bitset.h.

virtual BITSET::~BITSET (   )  [inline, virtual]

Destructor. Definition at line 690 of file bitset.h.

---

Member Function Documentation

virtual ERRVALUE BITSET::Assign (  UINT8 *  set, UINT32  NumEntries )  [inline, virtual]

Assign from old type bit arrays. Make sure resize happens Parameters: set  Pointer to old bit-array NumEntries  Number of items in old bit array Reimplemented from BITSET_UNOWNED. Definition at line 716 of file bitset.h.

void BITSET::Attach (  UINT8 *&  items, int  numitems )  [inline]

Attach a old bit array to the BITSET. After passing a buffer to Attach(), the BITSET "owns" the buffer and will free it in its destructor. Parameters: items  Reference to a pointer to the other bit array. The reason it's a reference is that after recording the pointer, Attach() will set your pointer to 0. This will prevent you from accidently freeing a pointer you no longer own. If you want it back, call the Detach() method Parameters: numitems  Number of items in array Definition at line 738 of file bitset.h.

UINT8* BITSET::Detach (   )  [inline]

Detach the buffer from the BITSET This turns ownership of the buffer over to the caller, who is then responsibile for seeing that it gets disposed of. After calling Detach(), the BITSET will behave as if it had just been constructed. In other words, it will be a NULL pointer pointing to 0 items. This means that if you want to know how many items are in the array returned, you'd better find out before} you call Detach()! Definition at line 758 of file bitset.h.

void BITSET::Free (   )  [inline]

Erase BITSET internals, same as calling destructor. Definition at line 767 of file bitset.h.

BITSET& BITSET::operator= (  const BITSET_UNOWNED &  rhs  )  [inline]

Assignment from BITSET_UNOWNED. Definition at line 706 of file bitset.h.

BITSET& BITSET::operator= (  const BITSET &  rhs  )  [inline]

Assignment from BITSET. Definition at line 696 of file bitset.h.

ERRVALUE BITSET::Resize (  UINT32  NumEntries  )  [inline]

Resize BITSET to a new number of entries. Set bits in last entry past old end to "false". Parameters: NumEntries  Number of elements to resize to Definition at line 775 of file bitset.h.

---

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

• mi32/bitset.h

---