BehaviorBase - Version 2.0 This class acts as a virtual parent for all behavior classes.
More...
|
virtual float | GetBehaviorVersion () |
| Gets the behavior version number.
|
|
| clBehaviorBase (clSimManager *p_oSimManager) |
| Constructor.
|
|
virtual | ~clBehaviorBase () |
| Destructor.
|
|
virtual void | Action () |
| This is the function which is called each timestep and performs the actual work of the behavior.
|
|
virtual short int | ValidateVersionNumber (float fTestVersion) |
| Makes sure that the version number of a file passed is between the minimum and current version numbers.
|
|
virtual void | RegisterTreeDataMembers () |
| Registers tree data members.
|
|
virtual void | SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos) |
| Sets the species/type combos for a behavior.
|
|
virtual void | SetNameData (char *cNameString) |
| Sets the string for the parameter file behavior.
|
|
virtual short int | GetNewTreeInts () |
| Gets the number of new tree integer data members this behavior wants to register.
|
|
virtual short int | GetNewTreeFloats () |
| Gets the number of new tree float data members this behavior wants to register.
|
|
virtual short int | GetNewTreeChars () |
| Gets the number of new tree character data members this behavior wants to register.
|
|
virtual short int | GetNewTreeBools () |
| Gets the number of new tree bool data members this behavior wants to register.
|
|
virtual short int | GetNumSpeciesTypeCombos () |
| Gets the number of species/type combos to which this behavior applies.
|
|
virtual short int | GetNumBehaviorSpecies () |
| Gets the number of unique tree species to which this behavior applies.
|
|
struct stcSpeciesTypeCombo | GetSpeciesTypeCombo (short int iIndex) |
| Gets one of this behavior's type/species combos.
|
|
virtual short int | GetBehaviorSpecies (short int iIndex) |
| Gets one of the behavior's species.
|
|
short int | GetBehaviorListNumber () |
| Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list.
|
|
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.
|
|
virtual DOMElement * | GetParentParametersElement (xercesc::DOMDocument *p_oDoc) |
| Formats the string for species/types query.
|
|
| clWorkerBase (clSimManager *p_oSimManager) |
| Constructor.
|
|
virtual | ~clWorkerBase () |
| Destructor.
|
|
char * | GetName () |
| Gets the object's namestring.
|
|
void | DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType) |
| Triggers the setup process.
|
|
virtual void | TimestepCleanup () |
| Performs any necessary cleanup operations at the end of a timestep.
|
|
virtual void | EndOfRunCleanup () |
| Performs any necessary cleanup operations at the end of a run.
|
|
virtual void | DoCommand (char *cCommand, char *cArguments) |
| If a behavior has registered a command line command with the sim manager, this allows it to be called.
|
|
|
short int | m_iNumSpeciesTypeCombos |
| How many type/species combos a behavior will act on.
|
|
short int | m_iNumBehaviorSpecies |
| How many distinct species are in the combo list - important for filling species-specific values from parameter file.
|
|
short int * | mp_iWhatSpecies |
| List of distinct species - for filling species-specific values from parameter file.
|
|
stcSpeciesTypeCombo * | mp_whatSpeciesTypeCombos |
| Array of species/type combos that the behavior will act on.
|
|
short int | m_iNewTreeInts |
| The number of new tree integer data members this behavior wants to add.
|
|
short int | m_iNewTreeFloats |
| The number of new tree float data members this behavior wants to add.
|
|
short int | m_iNewTreeChars |
| The number of new tree character data members this behavior wants to add.
|
|
short int | m_iNewTreeBools |
| The number of new tree boolean data members this behavior wants to add.
|
|
short int | m_iBehaviorListNumber |
| The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior.
|
|
float | m_fVersionNumber |
| Version number - this will be rounded to 2 digits after the decimal place.
|
|
std::string | m_sXMLRoot |
| XML root that encloses the parameters for this behavior.
|
|
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.
|
|
char | m_cNameString [MAX_NAMESTRING_SIZE] |
| Object's identifying namestring.
|
|
int * | mp_iAllowedFileTypes |
| List of the input file types this object can handle.
|
|
int | m_iNumAllowedTypes |
| Number of input file types this object can handle.
|
|
BehaviorBase - Version 2.0 This class acts as a virtual parent for all behavior classes.
This allows the Simulation Manager to work with behavior objects without knowing anything about them.
There should not be any objects instantiated from this class.
Because I am continually surprised at the basic functions I want to mess with in my derived classes, every function here is virtual. Most administrative dealings with behaviors have them cast to the clBehaviorBase class, so function-hiding won't work. Override to your heart's content.
Copyright 2011 Charles D. Canham.
- Author
- Lora E. Murphy
Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0; created version 2.0 (LEM)
virtual void clBehaviorBase::RegisterTreeDataMembers |
( |
| ) |
|
|
virtual |
Registers tree data members.
If a behavior has any tree data members to add, it should register them by overriding this function. It cannot be assumed at this point that any data will have been read from the parameter file for the behavior itself, although it can be assumed that the tree population has read its data.
Reimplemented in clMerchValueCalculator, clGrowthBase, clLaggedPostHarvestGrowth, clHarvestInterface, clBoleVolumeCalculator, clVolumeCalculator, clLightDepSeedSurvival, clQualityVigorClassifier, clCompetitionHarvest, clSnagDecomp, clDimensionAnalysis, clInsectInfestation, clEpiphyticEstablishment, clAbsoluteGrowth, clStormDamageApplier, clMortalityBase, clGeneralizedHarvestRegime, clMichMenNegGrowth, clLightBase, clCarbonValueCalculator, clTreeAgeCalculator, clCrownRadiusReporter, and clRandomBrowse.
virtual void clBehaviorBase::SetNameData |
( |
char * |
cNameString | ) |
|
|
inlinevirtual |
Sets the string for the parameter file behavior.
The string passed in the parameter file is, by default, ignored; but since it could be used by a behavior to pass information, a behavior class can override this function to capture this.
- Parameters
-
cNameString | The behavior name string from the parameter file. |
Reimplemented in clWeibullClimateGrowth, clNCIBAGrowth, clWeibullClimateQuadratGrowth, clLaggedPostHarvestGrowth, clHarvestInterface, clDisturbance, clFuncResponseSeedPredation, clLightDepSeedSurvival, clNCIGrowth, clNCIJuvenileGrowth, clSubstrateDepSeedSurvival, clAllometricGrowthIncrementer, clSizeDepLogisticGrowth, clShadedLinearGrowth, clLognormalGrowth, clRelativeGrowth, clNeighborhoodSeedPredation, clDoubleMMRelGrowth, clLogisticGrowth, clSimpleLinearGrowth, clLinearBiLevelGrowth, clDensitySeedSurvival, clStormKilledPartitionedBiomass, clPartitionedBiomass, clAbsoluteGrowth, clBrowsedRelativeGrowth, clStochasticBiLevelMortality, clClimateChange, clSpatialDispersal, clConstantRadialGrowth, and clConstantBAGrowth.