clPackage Class Reference

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

#include <Grid.h>

Public Member Functions
clPackage *	GetNextPackage ()
	Returns the next package in the linked list. More...
void	SetValue (short int iCode, int iValue)
	Sets the value of an integer data member. More...
void	SetValue (short int iCode, float fValue)
	Sets the value of a float data member. More...
void	SetValue (short int iCode, bool bValue)
	Sets the value of a bool data member. More...
void	SetValue (short int iCode, std::string sValue)
	Sets the value of a string data member. More...
void	GetValue (short int iCode, int *p_iValHolder)
	Gets the value of an integer data member. More...
void	GetValue (short int iCode, float *p_fValHolder)
	Gets the value of a float data member. More...
void	GetValue (short int iCode, bool *p_bValHolder)
	Gets the value of a boolean data member. More...
void	GetValue (short int iCode, std::string *p_sValHolder)
	Gets the value of a string data member. More...

Protected Member Functions
	clPackage (clGrid *p_oParentGrid, struct clGrid::stcRecords *p_oParentCell)
	Constructor. More...
	~clPackage ()
	Destructor. More...

Protected Attributes
clGrid *	mp_oParentGrid
	Package's parent grid. More...
clGrid::stcRecords *	mp_parentCell
	Package's parent grid cell. More...
int *	mp_iIntVals
	Array holding integer values. More...
float *	mp_fFloatVals
	Array holding float values. More...
std::string *	mp_sStringVals
	Array holding string values. More...
bool *	mp_bBoolVals
	Array holding bool values. More...
clPackage *	mp_oNext
	Pointer to next package in linked list. More...

Friends
class	clGrid
class	clGridTest
	So we can do automated testing. More...

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::clPackage ( clGrid *  p_oParentGrid, struct clGrid::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::~clPackage ( )

protected

Destructor.

Member Function Documentation

GetNextPackage()

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.

GetValue() [1/4]

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.

GetValue() [2/4]

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.

GetValue() [3/4]

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.

GetValue() [4/4]

void clPackage::GetValue	(	short int	iCode,
		std::string *	p_sValHolder
	)

Gets the value of a string data member.

Parameters

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

SetValue() [1/4]

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.

SetValue() [2/4]

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.

SetValue() [3/4]

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.

SetValue() [4/4]

void clPackage::SetValue	(	short int	iCode,
		std::string	sValue
	)

Sets the value of a string data member.

Parameters

iCode	Data member code.
sValue	Value to set.

Friends And Related Function Documentation

clGrid

friend class clGrid

friend

clGridTest

friend class clGridTest

friend

So we can do automated testing.

Member Data Documentation

mp_bBoolVals

bool* clPackage::mp_bBoolVals

protected

Array holding bool values.

Size is m_iNumBoolVals.

mp_fFloatVals

float* clPackage::mp_fFloatVals

protected

Array holding float values.

Size is m_iNumFloatVals.

mp_iIntVals

int* clPackage::mp_iIntVals

protected

Array holding integer values.

Size is m_iNumIntVals.

mp_oNext

clPackage* clPackage::mp_oNext

protected

Pointer to next package in linked list.

mp_oParentGrid

clGrid* clPackage::mp_oParentGrid

protected

Package's parent grid.

mp_parentCell

clGrid::stcRecords* clPackage::mp_parentCell

protected

Package's parent grid cell.

mp_sStringVals

std::string* clPackage::mp_sStringVals

protected

Array holding string values.

Size is m_iNumStringVals.

---

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

• Grid.h