Random Browse Version 1.0. More...

#include <RandomBrowse.h>

Inheritance diagram for clRandomBrowse:

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

	~clRandomBrowse ()
	Destructor. More...

void	Action ()
	Decides who is browsed. More...

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

void	RegisterTreeDataMembers ()
	Registers the "Browsed" bool 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
double *	mp_fBrowseProb
	Probability of browse (or mean prob). More...

double *	mp_fBrowseStdDev
	Standard deviation of browse probability, if using a normal draw each timestep. More...

char *	m_cQuery
	String to pass to clTreePopulation::Find() in order to get the trees for which to calculate volume. More...

short int **	mp_iBrowsedCodes
	Holds data member codes for "Browsed" bool data member. More...

short int	m_iNumSpecies
	For the destructor. More...

pdf	m_iPDF
	What distribution function to use to randomize the probabilities each timestep - currently only deterministic and normal supported. 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

Random Browse Version 1.0.

This class randomly chooses trees to be browsed according to a species specific probability of browse. The same browse probability can be used every time, or it can be the mean in a normal draw each timestep for each species.

This behavior adds a bool data member called "Browsed" to trees that holds whether (true) or not (false) the tree has been browsed.

This class's namestring and parameter call string are both "RandomBrowse".

Author: Lora E. Murphy

Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)

Constructor & Destructor Documentation

◆ clRandomBrowse()

clRandomBrowse::clRandomBrowse ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager clSimManager object.

◆ ~clRandomBrowse()

clRandomBrowse::~clRandomBrowse ( )

Destructor.

Deletes arrays.

Member Function Documentation

◆ Action()

void clRandomBrowse::Action ( )

virtual

Decides who is browsed.

A query is sent to the tree population to get all trees to which this behavior is applied. For each, a random number is compared to that species' browse probability. The result is placed in the "Browsed" bool tree data member.

Reimplemented from clBehaviorBase.

◆ GetData()

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

virtual

Does setup for this behavior.

This gets parameters and formats the query string for getting trees from the tree population.

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if any probability is not between 0 and 1.

Implements clWorkerBase.

◆ RegisterTreeDataMembers()

void clRandomBrowse::RegisterTreeDataMembers ( )

virtual

Registers the "Browsed" bool data member.

The return codes are captured in the mp_iBrowsedCodes array.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ m_cQuery

char* clRandomBrowse::m_cQuery

protected

String to pass to clTreePopulation::Find() in order to get the trees for which to calculate volume.

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

◆ m_iNumSpecies

short int clRandomBrowse::m_iNumSpecies

protected

For the destructor.

◆ m_iPDF

pdf clRandomBrowse::m_iPDF

protected

What distribution function to use to randomize the probabilities each timestep - currently only deterministic and normal supported.

◆ mp_fBrowseProb

double* clRandomBrowse::mp_fBrowseProb

protected

Probability of browse (or mean prob).

Array size is total number of species.

◆ mp_fBrowseStdDev

double* clRandomBrowse::mp_fBrowseStdDev

protected

Standard deviation of browse probability, if using a normal draw each timestep.

Array size is total number of species.

◆ mp_iBrowsedCodes

short int** clRandomBrowse::mp_iBrowsedCodes

protected

Holds data member codes for "Browsed" bool data member.

First array index is # species, second is number types.

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

RandomBrowse.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clRandomBrowse()

◆ ~clRandomBrowse()

Member Function Documentation

◆ Action()

◆ GetData()

◆ RegisterTreeDataMembers()

Member Data Documentation

◆ m_cQuery

◆ m_iNumSpecies

◆ m_iPDF

◆ mp_fBrowseProb

◆ mp_fBrowseStdDev

◆ mp_iBrowsedCodes