#include <TheGrids.h>
Public Member Functions | |
clGridManager (clSimManager *p_oSimManager) | |
Constructor. | |
int | GetObjectVersion () |
Returns the version number of the clGridManager class. | |
void | CreateObjects (xercesc::DOMDocument *p_oDoc) |
Creates grid objects from input file if there are maps. | |
clGridBase * | CreateGrid (char *cGridName, short int iNumIntVals, short int iNumFloatVals, short int iNumCharVals, short int iNumBoolVals, float fXCellLength=0, float fYCellLength=0) |
CreateGrid() This creates a grid object. |
The Grid Manager has a job unique among object managers in that the grid objects are relatively dumb. They are not all unique classes, they are separate instantiations of the same class. So the Grid Manager takes care of their construction.
Definitions of grid objects in the parameter or other file are assumed to be part of the definitions for the behaviors that will work on them, so the grid manager does not have a data reading routine. If another object wishes to initialize a grid object with data, it must assign the values itself after requesting that the grid manager create the grid.
Copyright 2003 Charles D. Canham.
clGridManager::clGridManager | ( | clSimManager * | p_oSimManager | ) | [inline] |
Constructor.
This constructor structure makes sure that there's no default constructor while also saying that this child class doesn't need its own constructor to do anything
p_oSimManager | Sim Manager object. |
int clGridManager::GetObjectVersion | ( | ) | [inline] |
Returns the version number of the clGridManager class.
Reimplemented from clObjectManagerBase.
void clGridManager::CreateObjects | ( | xercesc::DOMDocument * | p_oDoc | ) | [virtual] |
Creates grid objects from input file if there are maps.
p_oDoc | DOM tree of parsed input file. |
Reimplemented from clObjectManagerBase.
clGridBase* clGridManager::CreateGrid | ( | char * | cGridName, | |
short int | iNumIntVals, | |||
short int | iNumFloatVals, | |||
short int | iNumCharVals, | |||
short int | iNumBoolVals, | |||
float | fXCellLength = 0 , |
|||
float | fYCellLength = 0 | |||
) |
CreateGrid() This creates a grid object.
If there is already a grid object with the passed name, it overwrites it.
cGridName | The new grid's namestring. | |
iNumIntVals | Number of integer data members in a grid cell record. Can be 0. | |
iNumFloatVals | Number of float data members in a grid cell record. Can be 0. | |
iNumCharVals | Number of char data members in a grid cell record. Can be 0. | |
iNumBoolVals | Number of bool data members in a grid cell record. Can be 0. | |
fXCellLength | The length of a grid cell in the X direction, in meters. Not required. If ommitted this will default to the plot's cell length. | |
fYCellLength | The length of a grid cell in the Y direction, in meters. Not required. If this is ommitted (i.e. = 0), it is assumed the grid cells are square and the value for the X length is used. |