clPackage Class Reference

Package Class This class is for packages, which are used by grids. More...

#include <GridBase.h>

List of all members.

Public Member Functions

clPackageGetNextPackage ()
 Returns the next package in the linked list.
void SetValue (short int iCode, int iValue)
 Sets the value of an integer data member.
void SetValue (short int iCode, float fValue)
 Sets the value of a float data member.
void SetValue (short int iCode, bool bValue)
 Sets the value of a bool data member.
void SetValue (short int iCode, char *cValue)
 Sets the value of a char data member.
void GetValue (short int iCode, int *p_iValHolder)
 Gets the value of an integer data member.
void GetValue (short int iCode, float *p_fValHolder)
 Gets the value of a float data member.
void GetValue (short int iCode, bool *p_bValHolder)
 Gets the value of a boolean data member.
void GetValue (short int iCode, char *p_cValHolder)
 Gets the value of a char data member.

Protected Member Functions

 clPackage (clGridBase *p_oParentGrid, struct clGridBase::stcRecords *p_oParentCell)
 Constructor.
 ~clPackage ()
 Destructor.

Protected Attributes

clGridBasemp_oParentGrid
 Package's parent grid.
clGridBase::stcRecordsmp_parentCell
 Package's parent grid cell.
int * mp_iIntVals
 Array holding integer values.
float * mp_fFloatVals
 Array holding float values.
char ** mp_cCharVals
 Array holding char values.
bool * mp_bBoolVals
 Array holding bool values.
clPackagemp_oNext
 Pointer to next package in linked list.

Friends

class clGridBase
class clGridTest
 So we can do automated testing.


Detailed Description

Package Class This class is for packages, which are used by grids.

All packages have the same record structure. It depends on its parent grid to set the static member variables.


Constructor & Destructor Documentation

clPackage::clPackage ( clGridBase p_oParentGrid,
struct clGridBase::stcRecords p_oParentCell 
) [protected]

Constructor.

This will set up the value arrays for the grid cells. Values will be initialized to 0, false, or empty string, as appropriate.

Parameters:
p_oParentGrid The grid for which this is a package.
p_oParentCell The cell which owns this package.

clPackage::~clPackage (  )  [protected]

Destructor.


Member Function Documentation

clPackage* clPackage::GetNextPackage (  )  [inline]

Returns the next package in the linked list.

Can be used for traversing the linked list.

Returns:
The next package, or NULL if there is no next package.

void clPackage::SetValue ( short int  iCode,
int  iValue 
)

Sets the value of an integer data member.

Parameters:
iCode Data member code.
iValue Value to set.

void clPackage::SetValue ( short int  iCode,
float  fValue 
)

Sets the value of a float data member.

Parameters:
iCode Data member code.
fValue Value to set.

void clPackage::SetValue ( short int  iCode,
bool  bValue 
)

Sets the value of a bool data member.

Parameters:
iCode Data member code.
bValue Value to set.

void clPackage::SetValue ( short int  iCode,
char *  cValue 
)

Sets the value of a char data member.

Parameters:
iCode Data member code.
cValue Value to set.

void clPackage::GetValue ( short int  iCode,
int *  p_iValHolder 
)

Gets the value of an integer data member.

Parameters:
iCode Data member code.
p_iValHolder Address of variable into which to place the requested data member value.

void clPackage::GetValue ( short int  iCode,
float *  p_fValHolder 
)

Gets the value of a float data member.

Parameters:
iCode Data member code.
p_fValHolder Address of variable into which to place the requested data member value.

void clPackage::GetValue ( short int  iCode,
bool *  p_bValHolder 
)

Gets the value of a boolean data member.

Parameters:
iCode Data member code.
p_bValHolder Address of variable into which to place the requested data member value.

void clPackage::GetValue ( short int  iCode,
char *  p_cValHolder 
)

Gets the value of a char data member.

Parameters:
iCode Data member code.
p_cValHolder Address of variable into which to place the requested data member value.


Friends And Related Function Documentation

friend class clGridBase [friend]

friend class clGridTest [friend]

So we can do automated testing.


Member Data Documentation

Package's parent grid.

Package's parent grid cell.

int* clPackage::mp_iIntVals [protected]

Array holding integer values.

Size is m_iNumIntVals.

float* clPackage::mp_fFloatVals [protected]

Array holding float values.

Size is m_iNumFloatVals.

char** clPackage::mp_cCharVals [protected]

Array holding char values.

Size is m_iNumCharVals.

bool* clPackage::mp_bBoolVals [protected]

Array holding bool values.

Size is m_iNumBoolVals.

Pointer to next package in linked list.


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

Generated on Tue Apr 19 13:56:14 2011 for SORTIE Core C++ Documentation by  doxygen 1.5.6