BITSET_SHARED Class Reference

Shared Bit set. More...

#include <mi32/bitset.h>

Inheritance diagram for BITSET_SHARED:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 BITSET_SHARED (UINT8 *set, UINT32 NumEntries)
 BITSET_SHARED (const BITSET_UNOWNED &rhs)
 BITSET_SHARED (const BITSET_SHARED &rhs)
 BITSET_SHARED ()
virtual ~BITSET_SHARED ()
virtual ERRVALUE Assign (UINT8 *set, UINT32 NumEntries)
void Attach (UINT8 *&items, int numitems)
void Free ()
BITSET_SHAREDoperator= (const BITSET_UNOWNED &rhs)
BITSET_SHAREDoperator= (const BITSET_SHARED &rhs)
ERRVALUE Resize (UINT32 NumEntries)

Detailed Description

Shared Bit set.


Constructor & Destructor Documentation

BITSET_SHARED::BITSET_SHARED (  ) 

Default constructor.

BITSET_SHARED::BITSET_SHARED ( const BITSET_SHARED rhs  ) 

Copy constructor.

BITSET_SHARED::BITSET_SHARED ( const BITSET_UNOWNED rhs  ) 

Construct from BITSET_UNOWNED.

BITSET_SHARED::BITSET_SHARED ( 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_SHARED::~BITSET_SHARED (  )  [virtual]

Destructor.


Member Function Documentation

virtual ERRVALUE BITSET_SHARED::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_SHARED::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
void BITSET_SHARED::Free (  ) 

Erase BITSET internals, same as calling destructor.

BITSET_SHARED& BITSET_SHARED::operator= ( const BITSET_UNOWNED rhs  ) 

Assignment from BITSET_UNOWNED.

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

Assignment from BITSET_SHARED.

ERRVALUE BITSET_SHARED::Resize ( UINT32  NumEntries  ) 

Resize BITSET_SHARED 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 Sun Oct 7 21:33:14 2012 for TNTsdk 2012 by  doxygen 1.6.1