BITSET Class Reference

Bit set. More...

#include <mi32/bitset.h>

Inheritance diagram for BITSET:

Inheritance graph
[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 ()
UINT8Detach ()
void Free ()
BITSEToperator= (const BITSET_UNOWNED &rhs)
BITSEToperator= (const BITSET &rhs)
ERRVALUE Resize (UINT32 NumEntries)
virtual ~BITSET ()

Detailed Description

Bit set.

Definition at line 482 of file bitset.h.


Constructor & Destructor Documentation

BITSET::BITSET  ) 
 

Default constructor.

BITSET::BITSET const BITSET rhs  ) 
 

Copy constructor.

BITSET::BITSET const BITSET_UNOWNED rhs  ) 
 

Construct from BITSET_UNOWNED.

BITSET::BITSET UINT8 set,
UINT32  NumEntries
 

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

virtual BITSET::~BITSET  )  [virtual]
 

Destructor.


Member Function Documentation

virtual ERRVALUE BITSET::Assign UINT8 set,
UINT32  NumEntries
[virtual]
 

Assign from old type bit arrays.

Parameters:
set  Pointer to old bit-array
NumEntries  Number of items in old bit array

Reimplemented from BITSET_UNOWNED.

void BITSET::Attach UINT8 *&  items,
int  numitems
 

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

UINT8* BITSET::Detach  ) 
 

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()!

void BITSET::Free  ) 
 

Erase BITSET internals, same as calling destructor.

BITSET& BITSET::operator= const BITSET_UNOWNED rhs  ) 
 

Assignment from BITSET_UNOWNED.

BITSET& BITSET::operator= const BITSET rhs  ) 
 

Assignment from BITSET.

ERRVALUE BITSET::Resize UINT32  NumEntries  ) 
 

Resize BITSET to a new number of entries.

Parameters:
NumEntries  Number of elements to resize to


The documentation for this class was generated from the following file:
Generated on Wed May 31 15:28:17 2006 for TNTsdk by  doxygen 1.3.8-20040913