clBehaviorManager Class Reference

Behaviors - Version 1.0 Behavior Manager. More...

#include <Behaviors.h>

Inheritance diagram for clBehaviorManager:

clObjectManagerBase

List of all members.

Public Member Functions

 clBehaviorManager (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.
int GetObjectVersion ()
 Returns the version number of the clBehaviorManager class.
void CreateObjects (DOMDocument *p_oDoc)
 Creates the behavior objects for a run.

Protected Member Functions

void CreateBehavior (behaviorData *p_data)
 Creates an individual behavior object.

Classes

struct  behaviorData
 Holds setup information for a single behavior object. More...


Detailed Description

Behaviors - Version 1.0 Behavior Manager.

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

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

Constructor & Destructor Documentation

clBehaviorManager::clBehaviorManager ( 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

int clBehaviorManager::GetObjectVersion (  )  [inline]

Returns the version number of the clBehaviorManager class.

Returns:
clBehaviorManager class version number.

Reimplemented from clObjectManagerBase.

void clBehaviorManager::CreateObjects ( DOMDocument *  p_oDoc  ) 

Creates the behavior objects for a run.

The objects are created from the behaviorList tags in the document. If there are currently objects created, they are deleted and the new objects created. This function will validate the species and tree types (if any) to apply to each behavior.

Parameters:
p_oDoc DOM tree parsed from the XML file.
Exceptions:
ModelErr if a species or tree type is invalid.

void clBehaviorManager::CreateBehavior ( behaviorData p_data  )  [protected]

Creates an individual behavior object.

The manager will create the object and add it to the end of the behavior list array. If there is already a behavior present with this name, this will overwrite that behavior. It will also validate the version number from the parameter file.

Parameters:
p_data A pointer to a behaviorData structure containing the behavior's setup information.
Exceptions:
ModelErr if the behavior isn't recognized.


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

Generated on Tue Apr 19 13:56:07 2011 for SORTIE Core C++ Documentation by  doxygen 1.5.6