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

Populations - Version 1.1 Population object manager. More...

#include <Populations.h>

Inheritance diagram for clPopulationManager:
clObjectManagerBase

Public Member Functions

 clPopulationManager (clSimManager *p_oSimManager)
 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. More...
 
void CreateObjects (xercesc::DOMDocument *p_oDoc)
 Creates the tree population objects. More...
 
- Public Member Functions inherited from clObjectManagerBase
int GetObjectVersion ()
 Returns the version number of the clObjectManagerBase class. More...
 
 clObjectManagerBase (clSimManager *p_oSimManager)
 Constructor. More...
 
virtual ~clObjectManagerBase ()
 Destructor. More...
 
void FreeMemory ()
 Deletes the managed objects array. More...
 
int GetNumberOfObjects ()
 Returns the number of objects under management for an object manager. More...
 
clWorkerBasePassObjectPointer (int iObjectNumber)
 Gets a specified object under management. More...
 
clWorkerBasePassObjectPointer (std::string sName)
 Gets a specified object under management. More...
 
void DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
 Triggers the setup process for all objects managed by this manager. More...
 
void TimestepCleanup ()
 Completes timestep cleanup tasks both for this object manager and all its managed objects. More...
 
void EndOfRunCleanup ()
 Completes any end-of-run cleanup tasks both for this object manager and all its managed objects. More...
 

Additional Inherited Members

- Protected Attributes inherited from clObjectManagerBase
clWorkerBase ** mp_oObjectArray
 The array of objects under the control of the object manager. More...
 
int m_iNumObjects
 The number of objects currently under management. More...
 
clSimManagermp_oSimManager
 Pointer to the Simulation Manager. More...
 

Detailed Description

Populations - Version 1.1 Population object manager.

Copyright 2003 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
April 28, 2004 - Submitted as beta (LEM)
January 6, 2011 - Added ghost tree population (LEM)

Constructor & Destructor Documentation

◆ clPopulationManager()

clPopulationManager::clPopulationManager ( clSimManager p_oSimManager)
inline

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.

Member Function Documentation

◆ CreateObjects()

void clPopulationManager::CreateObjects ( xercesc::DOMDocument *  p_oDoc)
virtual

Creates the tree population objects.

Reimplemented from clObjectManagerBase.


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