Crown radius reporter, version 1.0. More...

#include <CrownRadiusReporter.h>

Inheritance diagram for clCrownRadiusReporter:

Public Member Functions
	clCrownRadiusReporter (clSimManager *p_oSimManager)
	Constructor. More...

	~clCrownRadiusReporter ()
	Destructor. More...

void	Action ()
	Updates crown radii. More...

void	GetData (xercesc::DOMDocument *p_oDoc)
	Does setup for this behavior. More...

void	RegisterTreeDataMembers ()
	Registers the "Crown Radius" float data member. More...

Public Member Functions inherited from clBehaviorBase
virtual float	GetBehaviorVersion ()
	Gets the behavior version number. More...

	clBehaviorBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clBehaviorBase ()
	Destructor. More...

virtual short int	ValidateVersionNumber (float fTestVersion)
	Makes sure that the version number of a file passed is between the minimum and current version numbers. More...

virtual void	SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
	Sets the species/type combos for a behavior. More...

virtual void	SetNameData (std::string sNameString)
	Sets the string for the parameter file behavior. More...

virtual short int	GetNewTreeInts ()
	Gets the number of new tree integer data members this behavior wants to register. More...

virtual short int	GetNewTreeFloats ()
	Gets the number of new tree float data members this behavior wants to register. More...

virtual short int	GetNewTreeChars ()
	Gets the number of new tree character data members this behavior wants to register. More...

virtual short int	GetNewTreeBools ()
	Gets the number of new tree bool data members this behavior wants to register. More...

virtual short int	GetNumSpeciesTypeCombos ()
	Gets the number of species/type combos to which this behavior applies. More...

virtual short int	GetNumBehaviorSpecies ()
	Gets the number of unique tree species to which this behavior applies. More...

struct stcSpeciesTypeCombo	GetSpeciesTypeCombo (short int iIndex)
	Gets one of this behavior's type/species combos. More...

virtual short int	GetBehaviorSpecies (short int iIndex)
	Gets one of the behavior's species. More...

short int	GetBehaviorListNumber ()
	Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

void	SetBehaviorListNumber (short int iNumber)
	Sets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

std::string	FormatSpeciesTypeQueryString ()
	Formats the string for species/types query. More...

virtual DOMElement *	GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
	This will get the correct set of parameters for this behavior based on the behavior list position number. 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...

clSimManager *	GetSimManager ()

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

Protected Attributes
short int **	mp_iRadiusCodes
	Data member codes for "Crown Radius" data member. More...

std::string	m_sQuery
	String to pass to clTreePopulation::Find() in order to get the trees for which to report crown radius. More...

int	m_iNumSpecies
	Number of species, for destructor. More...

Protected Attributes inherited from clBehaviorBase
short int	m_iNumSpeciesTypeCombos
	How many type/species combos a behavior will act on. More...

short int	m_iNumBehaviorSpecies
	How many distinct species are in the combo list - important for filling species-specific values from parameter file. More...

short int *	mp_iWhatSpecies
	List of distinct species - for filling species-specific values from parameter file. More...

stcSpeciesTypeCombo *	mp_whatSpeciesTypeCombos
	Array of species/type combos that the behavior will act on. More...

short int	m_iNewTreeInts
	The number of new tree integer data members this behavior wants to add. More...

short int	m_iNewTreeFloats
	The number of new tree float data members this behavior wants to add. More...

short int	m_iNewTreeChars
	The number of new tree character data members this behavior wants to add. More...

short int	m_iNewTreeBools
	The number of new tree boolean data members this behavior wants to add. More...

short int	m_iBehaviorListNumber
	The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. More...

float	m_fVersionNumber
	Version number - this will be rounded to 2 digits after the decimal place. More...

std::string	m_sXMLRoot
	XML root that encloses the parameters for this behavior. More...

float	m_fMinimumVersionNumber
	Minimum version number - this behavior will run parameter data for a file marked between this number and the current version number, inclusive. 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...

clSimManager *	mp_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...

Additional Inherited Members
Protected Member Functions inherited from clWorkerBase
void	AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
	Creates the proper identifying filecode for an XML file. More...

Detailed Description

Crown radius reporter, version 1.0.

This behavior reports crown radius. It adds a float data member to the tree called "Crown_Radius" and updates it each timestep. Then it can be added to output.

This behavior can only be applied to saplings, adults, and snags.

The namestring and parameter file call string for this behavior are both "Crown Radius Reporter".

Author: Lora E. Murphy

Edit history:
--------------—
June 17, 2008 - Created (LEM)

Constructor & Destructor Documentation

◆ clCrownRadiusReporter()

clCrownRadiusReporter::clCrownRadiusReporter ( clSimManager * p_oSimManager )

Constructor.

◆ ~clCrownRadiusReporter()

clCrownRadiusReporter::~clCrownRadiusReporter ( )

Destructor.

Frees memory.

Member Function Documentation

◆ Action()

void clCrownRadiusReporter::Action ( )

virtual

Updates crown radii.

A query is sent to the tree population to get all trees to which this behavior is applied.

Reimplemented from clBehaviorBase.

◆ GetData()

void clCrownRadiusReporter::GetData ( xercesc::DOMDocument * p_oDoc )

virtual

Does setup for this behavior.

It formats a query string for finding trees to which this behavior applies. It then finds any initial conditions trees and sets their radii.

Parameters

p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

◆ RegisterTreeDataMembers()

void clCrownRadiusReporter::RegisterTreeDataMembers ( )

virtual

Registers the "Crown Radius" float data member.

The return codes are captured in the mp_iRadiusCodes array.

Exceptions

modelErr if this behavior is being applied to any tree type except saplings and adults.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ m_iNumSpecies

int clCrownRadiusReporter::m_iNumSpecies

protected

Number of species, for destructor.

◆ m_sQuery

std::string clCrownRadiusReporter::m_sQuery

protected

String to pass to clTreePopulation::Find() in order to get the trees for which to report crown radius.

This will instigate a species/type search for all the species and types to which this behavior applies.

◆ mp_iRadiusCodes

short int** clCrownRadiusReporter::mp_iRadiusCodes

protected

Data member codes for "Crown Radius" data member.

First array index is # species, second is number types

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

CrownRadiusReporter.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clCrownRadiusReporter()

◆ ~clCrownRadiusReporter()

Member Function Documentation

◆ Action()

◆ GetData()

◆ RegisterTreeDataMembers()

Member Data Documentation

◆ m_iNumSpecies

◆ m_sQuery

◆ mp_iRadiusCodes