DataBlockClass Class Reference

A C++ wrapper for struct DataBlock. More...

#include <datablockclass.h>

Collaboration diagram for DataBlockClass:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DataBlockClass ()
 DataBlockClass (struct DataBlock *dataBlock)
 DataBlockClass (char *data, int size)
 ~DataBlockClass ()
DataBlockdetatch ()
char * getData ()
int getSize ()
void setData (char *data, int size)

Detailed Description

A C++ wrapper for struct DataBlock.

The base unit data used in communication among Processes. This class provides several constructions and destruction for struct DataBlock. The underlying struct exists to ease communciation of data to other languages.

See also:
DataBlock


Constructor & Destructor Documentation

DataBlockClass::DataBlockClass  ) 
 

Default constructor.

DataBlockClass::DataBlockClass struct DataBlock dataBlock  ) 
 

Construct from an existing dataBlock. No new memory is allocated. Destruction of the struct DataBlock will now be handled by the newly constructed DataBlockClass

Parameters:
dataBlock 

DataBlockClass::DataBlockClass char *  data,
int  size
 

Construct a DataBlockClass from existing data. Internally new memory is allocated and the data is copyed.

Parameters:
data A pointer to the data
size The size of the data

DataBlockClass::~DataBlockClass  ) 
 


Member Function Documentation

struct DataBlock * DataBlockClass::detatch  ) 
 

Release the internal struct DataBlock. This ensures that destruction of the DataBlockClass will not destruct the struct DataBlock.

Returns:
The struct DataBlock

char * DataBlockClass::getData  ) 
 

int DataBlockClass::getSize  ) 
 

void DataBlockClass::setData char *  data,
int  size
 

Frees any current data and copies the new data.

Parameters:
data The data to be copied.
size The size of the data to be copied


The documentation for this class was generated from the following files:
Generated on Wed Apr 5 21:03:57 2006 for Sesame by  doxygen 1.4.6