SORTIE Core C++ Documentation
Public Member Functions | List of all members
clPopulationBase Class Reference

PopulationBase - Version 1.0 This class acts as a virtual parent for all population classes. More...

#include <PopulationBase.h>

Inheritance diagram for clPopulationBase:
clWorkerBase clGhostTreePopulation clTreePopulation

Public Member Functions

virtual void DoDataUpdates ()
 Performs cleanup between behavior action calls. More...
 
virtual ~clPopulationBase ()
 Destructor. More...
 
 clPopulationBase (clSimManager *p_oSimManager)
 Constructor. More...
 
- Public Member Functions inherited from clWorkerBase
 clWorkerBase (clSimManager *p_oSimManager)
 Constructor. More...
 
virtual ~clWorkerBase ()
 Destructor. More...
 
std::string GetName ()
 Gets the object's namestring. More...
 
clSimManagerGetSimManager ()
 
void DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
 Triggers the setup process. More...
 
virtual void TimestepCleanup ()
 Performs any necessary cleanup operations at the end of a timestep. More...
 
virtual void EndOfRunCleanup ()
 Performs any necessary cleanup operations at the end of a run. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clWorkerBase
virtual void GetData (xercesc::DOMDocument *p_oDoc)=0
 Performs an object's setup. More...
 
void AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
 Creates the proper identifying filecode for an XML file. More...
 
- Protected Attributes inherited from clWorkerBase
std::string m_sNameString
 If a behavior has registered a command line command with the sim manager, this allows it to be called. More...
 
clSimManagermp_oSimManager
 Pointer to the simulation manager object. More...
 
int * mp_iAllowedFileTypes
 List of the input file types this object can handle. More...
 
int m_iNumAllowedTypes
 Number of input file types this object can handle. More...
 

Detailed Description

PopulationBase - Version 1.0 This class acts as a virtual parent for all population classes.

This allows the Simulation Manager to work with population objects without knowing anything about them.

There should not be any objects instantiated from this class.

Copyright 2003 Charles D. Canham.

Author
Lora E. Murphy


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

Constructor & Destructor Documentation

◆ ~clPopulationBase()

virtual clPopulationBase::~clPopulationBase ( )
inlinevirtual

Destructor.

◆ clPopulationBase()

clPopulationBase::clPopulationBase ( clSimManager p_oSimManager)
inline

Constructor.

Parameters
p_oSimManagerSim Manager object.

Member Function Documentation

◆ DoDataUpdates()

virtual void clPopulationBase::DoDataUpdates ( )
inlinevirtual

Performs cleanup between behavior action calls.

This can be overridden in case a population has any cleanup or updating to do between action calls.

Reimplemented in clTreePopulation.


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