clGridManager Class Reference

Grid Manager - Version 1.0 The file names for this unit are TheGrids.x because for some reason "Grids" were unacceptable to Builder. More...

#include <TheGrids.h>

Inheritance diagram for clGridManager:

clObjectManagerBase

List of all members.

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.
clGridBaseCreateGrid (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.


Detailed Description

Grid Manager - Version 1.0 The file names for this unit are TheGrids.x because for some reason "Grids" were unacceptable to Builder.

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.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta (LEM)

Constructor & Destructor Documentation

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

Parameters:
p_oSimManager Sim Manager object.


Member Function Documentation

int clGridManager::GetObjectVersion (  )  [inline]

Returns the version number of the clGridManager class.

Returns:
clGridManager class version number.

Reimplemented from clObjectManagerBase.

void clGridManager::CreateObjects ( xercesc::DOMDocument *  p_oDoc  )  [virtual]

Creates grid objects from input file if there are maps.

Parameters:
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.

Parameters:
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.
Returns:
A pointer to the new grid object.


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

Generated on Wed Oct 28 13:58:45 2009 for SORTIE Core C++ Documentation by  doxygen 1.5.6