|
SORTIE Core C++ Documentation
|
This is an automated testing behavior. More...
#include <RandomSeedLogger.h>
Public Member Functions | |
| void | Action () |
| Does nothing. | |
| clRandomSeedLogger (clSimManager *p_oSimManager) | |
| Constructor. | |
Public Member Functions inherited from clBehaviorBase | |
| virtual float | GetBehaviorVersion () |
| Gets the behavior version number. | |
| clBehaviorBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clBehaviorBase () |
| Destructor. | |
| 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. | |
Public Member Functions inherited from clWorkerBase | |
| 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. | |
Protected Member Functions | |
| void | GetData (xercesc::DOMDocument *p_oDoc) |
| Writes the log with the random seed value. | |
Additional Inherited Members | |
Protected Attributes inherited from clBehaviorBase | |
| 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. | |
Static Protected Attributes inherited from clWorkerBase | |
| static clSimManager * | mp_oSimManager |
| Pointer to the simulation manager object. | |
This is an automated testing behavior.
It will log the actual random seed of a run in a file called "RandomSeed.txt". This is useful if you want to be able to go back and replicate a run exactly but 0 was specified in the parameter file as the random seed.
Copyright 2003 Charles D. Canham.
Edit history:
--------------—
April 28, 2004 - Submitted as beta (LEM)
| clRandomSeedLogger::clRandomSeedLogger | ( | clSimManager * | p_oSimManager | ) |
Constructor.
| p_oSimManager | Sim manager object. |
|
inlinevirtual |
Does nothing.
Reimplemented from clBehaviorBase.
|
protectedvirtual |
Writes the log with the random seed value.
| p_oDoc | Parsed parameter file object. |
Implements clWorkerBase.
1.8.2