RECORDARRAY Class Reference

General array of records with simple iteration support. More...

#include <mi32/recordarray.h>

Inheritance diagram for RECORDARRAY:
Inheritance graph
[legend]

List of all members.

Classes

class  RECORD
 Record in array with iteration capability. More...

Public Member Functions

 RECORDARRAY (UINT32 RecordSize=1)
 ~RECORDARRAY ()
UINT32 GetNumRecords () const
UINT8GetPtrBuffer ()
const UINT8GetPtrBuffer () const
UINT8GetPtrRecord (UINT32 idx)
const UINT8GetPtrRecord (UINT32 idx) const
UINT32 GetRecordSize () const
ERRVALUE Resize (UINT32 NumRecords)
void SetRecordSize (UINT32 RecordSize)

Detailed Description

General array of records with simple iteration support.


Constructor & Destructor Documentation

RECORDARRAY::RECORDARRAY ( UINT32  RecordSize = 1  )  [explicit]

Construct with optional record size.

Parameters:
RecordSize Record size, cannot be 0
RECORDARRAY::~RECORDARRAY (  ) 

Destructor.


Member Function Documentation

UINT32 RECORDARRAY::GetNumRecords (  )  const [inline]

Get number of records.

UINT8* RECORDARRAY::GetPtrBuffer (  )  [inline]

Get (non-const) pointer to start of buffer.

const UINT8* RECORDARRAY::GetPtrBuffer (  )  const [inline]

Get (const) pointer to start of buffer.

UINT8* RECORDARRAY::GetPtrRecord ( UINT32  idx  )  [inline]

Get (non-const) pointer to start of buffer.

const UINT8* RECORDARRAY::GetPtrRecord ( UINT32  idx  )  const [inline]

Get (const) pointer to record at specified index.

UINT32 RECORDARRAY::GetRecordSize (  )  const [inline]

Get size of record.

ERRVALUE RECORDARRAY::Resize ( UINT32  NumRecords  ) 

Resize array.

All RECORD instances referencing this array will become invalid. Product of number of records and record size must be less than 2^32.

Parameters:
NumRecords Number of records
void RECORDARRAY::SetRecordSize ( UINT32  RecordSize  ) 

Set record size.

Number of records will be reset to 0.

Parameters:
RecordSize Record size, cannot be 0

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

Generated on Sun Oct 7 21:33:45 2012 for TNTsdk 2012 by  doxygen 1.6.1