SORTIE Java Interface
1
|
Corresponds to the clMastingNonSpatialDisperse class. More...
Public Member Functions | |
MastingNonSpatialDisperse (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString) throws ModelException | |
Constructor. | |
void | changeOfSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies) throws ModelException |
Overridden to do enums. | |
void | validateData (TreePopulation oPop) throws ModelException |
Validates the data in preparation for parameter file writing or some such. | |
![]() | |
DisperseBase (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString) | |
Constructor. | |
![]() | |
GUIManager | getGUIManager () |
Behavior (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString) | |
Constructor. | |
int | getNumberOfDataObjects () |
Gets the number of managed data objects. | |
ModelData | getDataObject (int iInd) |
Gets the managed data object at a particular index. | |
void | validate () throws ModelException |
Behavior performs an internal check to make sure its settings are consistent and logical. | |
void | setListPosition (int iListPosition) |
Sets the behavior list position. | |
int | getListPosition () |
Gets the behavior list position. | |
String | getXMLParametersRoot () |
Gets the XML parameter root string. | |
int | getNumberNewDataMembers () |
DataMember | getNewTreeDataMember (int iIndex) throws ModelException |
void | setCanApplyTo (int iType, boolean bCanApply) |
Sets whether this behavior can apply to a given tree type. | |
String | getParameterFileBehaviorName () |
Gets the parameter file name for this behavior. | |
double | getVersion () |
Gets behavior's parameter file version. | |
double | getMinimumVersion () |
Gets behavior's parameter file minimum version. | |
String | getDescriptor () |
Gets the descriptor string. | |
void | setDescriptor (String s) |
Sets the descriptor string. | |
int | getNumberOfCombos () |
Gets the number of species/type combos to which this behavior applies. | |
int | getNumberOfGrids () |
Gets the number of grids to which this behavior applies. | |
void | deleteSpeciesTypeCombo (int iIndex) throws ModelException |
Deletes the SpeciesTypeCombo at the given index. | |
void | clearSpeciesTypeCombos () |
Empties the species/type combo list. | |
SpeciesTypeCombo | getSpeciesTypeCombo (int iIndex) throws ModelException |
Returns the SpeciesTypeCombo at the given index of the species/type combo list. | |
Grid | getGrid (int iIndex) throws ModelException |
Returns the Grid at the given index of the grid applies to list. | |
ModelData | getRequiredData (int iIndex) |
Returns the required data object at a given index. | |
int | getNumberOfRequiredDataObjects () |
Gets the number of required data objects for this behavior. | |
void | addSpeciesTypeCombo (SpeciesTypeCombo oCombo) throws ModelException |
Adds a new species/type combo to the list to which this behavior applies. | |
void | addGrid (Grid oGrid) |
Adds a new Grid to the list to which this behavior applies. | |
void | addRequiredData (ModelData oData) |
Adds a piece of required data to the list. | |
boolean[] | getWhichSpeciesUsed (TreePopulation oPop) |
Returns which species to which this behavior is applied. | |
boolean | setVectorValueByXMLTag (String sXMLTag, String sXMLParentTag, Vector< String > p_oData, String[] p_sChildXMLTags, boolean[] p_bAppliesTo, Attributes oParentAttributes, Attributes[] p_oAttributes) throws ModelException |
Sets a data vector's value. | |
void | setVectorValues (ModelVector oData, Float[] p_fValuesToSet, boolean[] p_bAppliesTo) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector oData, Float[] p_fValuesToSet) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector oData, Double[] p_fValuesToSet, boolean[] p_bAppliesTo) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector oData, Double[] p_fValuesToSet) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector oData, Integer[] p_iValuesToSet, boolean[] p_bAppliesTo) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector oData, String[] p_sValuesToSet) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector oData, String[] p_sValuesToSet, boolean[] p_bAppliesTo) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector oData, Integer[] p_iValuesToSet) |
Sets the values for vector variables. | |
void | setVectorValues (ModelVector p_oData, Vector< String > p_oValuesToSet, boolean[] p_bAppliesTo) throws ModelException |
Sets the values for vector variables. | |
boolean | setSingleValueByXMLTag (String sXMLTag, String sXMLParentTag, Attributes oAttributes, Object oData) throws ModelException |
Sets a data object's value. | |
ModelData | findObjectByXMLTag (String sXMLTag) |
Finds an object based on its XML tag. | |
void | copySpecies (int iSpeciesCopyFrom, int iSpeciesCopyTo) throws ModelException |
Copies one species to another. | |
void | writeXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException |
Writes the XML data to a parameter file for the behaviors owned by this object. | |
void | writeSpeciesSpecificValue (BufferedWriter jOut, ModelVector p_oData, TreePopulation oPop) throws java.io.IOException, ModelException |
Writes a set of species-specific float values to a parameter file. | |
void | writeSpeciesSpecificValue (BufferedWriter jOut, ModelVector p_oData, TreePopulation oPop, boolean[] p_bFlags) throws java.io.IOException, ModelException |
Writes a set of species-specific values to a parameter file for a certain subset of species. | |
void | readXMLParentTag (String sXMLTag, Attributes oAttributes) throws ModelException |
Accepts an XML parent tag (empty, no data) from the parser. | |
void | changeOfSpeciesName (String sOldSpecies, String sNewSpecies) |
Performs any necessary tasks associated with changing the name of a species. | |
void | changeOfSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies) throws ModelException |
Triggered when there is a change in the species list. | |
boolean | getAutoDisplayParameters () |
Gets whether to auto-display this object's parameters. | |
ModelData | findObjectByDescriptor (String sDescriptor) |
Finds an object based on its descriptor. | |
void | writeBehaviorNode (BufferedWriter out, TreePopulation oPop) throws ModelException |
Writes behavior tags to the parameter file. | |
BehaviorParameterDisplay | formatDataForDisplay (TreePopulation oPop) |
Formats data for display in a set of JTables. | |
void | readDataFromDisplay (Vector< TableData > p_oData, TreePopulation oPop) throws ModelException |
Reads in data from the parameter display window. | |
boolean | canBeDuplicated () |
Whether or not this behavior can be duplicated in the run. | |
boolean | canBeEditedAutomatically () |
Whether or not this behavior can be edited with the automatic parameter retrieval and editing tools. | |
void | endOfParameterFileRead () |
Called at the end of the parameter file read process. | |
void | changeOfPlotResolution (float fOldX, float fOldY, float fNewX, float fNewY) throws ModelException |
Performs any tasks associated with a change of plot resolution. | |
Protected Attributes | |
ModelVector | mp_iNonSpatialMastNonMastFunction |
Masting non-spatial disperse - distribution function to pick seeds in non-mast conditions. | |
ModelVector | mp_fNonSpatialMastBinomialP |
Masting non-spatial disperse - P parameter for binomial distribution for deciding whether to mast. | |
ModelVector | mp_iNonSpatialMastMastFunction |
Masting non-spatial disperse - distribution function to pick seeds in mast conditions. | |
ModelVector | mp_fNonSpatialMastMastInvGaussMu |
Masting non-spatial disperse - mu parameter for inverse gaussian distribution - mast conditions. | |
ModelVector | mp_fNonSpatialMastMastInvGaussLambda |
Masting non-spatial disperse - lambda parameter for inverse gaussian distribution - mast conditions. | |
ModelVector | mp_fNonSpatialMastNonMastInvGaussMu |
Masting non-spatial disperse - mu parameter for inverse gaussian distribution - non-mast conditions. | |
ModelVector | mp_fNonSpatialMastNonMastInvGaussLambda |
Masting non-spatial disperse - lambda parameter for inverse gaussian distribution - non-mast conditions. | |
ModelVector | mp_fNonSpatialMastMastNormalMean |
Masting non-spatial disperse - mean for normal distribution - mast conditions. | |
ModelVector | mp_fNonSpatialMastMastNormalStdDev |
Masting non-spatial disperse - standard deviation for normal distribution. | |
ModelVector | mp_fNonSpatialMastNonMastNormalMean |
Masting non-spatial disperse - mean for normal distribution - non-mast conditions. | |
ModelVector | mp_fNonSpatialMastNonMastNormalStdDev |
Masting non-spatial disperse - standard deviation for normal distribution. | |
ModelVector | mp_iNonSpatialMastMastGroupID |
Masting non-spatial disperse - group identification for each species. | |
![]() | |
ModelVector | mp_fMinDbhForReproduction |
Minimum DBH for reproduction for each species. | |
![]() | |
GUIManager | m_oManager |
GUIManager object. | |
BehaviorTypeBase | m_oParent |
Parent manager. | |
Vector< ModelData > | mp_oAllData = new Vector<ModelData>() |
All data for this object. | |
Vector< SpeciesTypeCombo > | mp_oTreesAppliesTo = new Vector<SpeciesTypeCombo>(0) |
A set of SpeciesTypeCombo objects to which this behavior is applied - or none if it is not applied to trees. | |
Vector< String > | mp_oGridsAppliesTo = new Vector<String>(0) |
A set of strings with the name of Grids to which this behavior is applied - or none if it is not applied to grids. | |
Vector< DataMember > | mp_oNewTreeDataMembers = new Vector<DataMember>(0) |
The new tree data members that this behavior adds, above and beyond the basic tree population data members. | |
boolean | m_bCanEditAutomatically = true |
Whether or not this behavior can be edited automatically (true) or must be edited with its own dialog (false) | |
boolean | m_bCanBeDuplicated = true |
Whether or not this behavior can have multiple copies in a run or not. | |
boolean | m_bAutoDisplayParameters = true |
Whether or not to auto-display this object's parameters. | |
String | m_sDescriptor = "" |
This is what will be displayed as the name of a given behavior in the GUI. | |
String | m_sParFileTag = "" |
String which is used to identify this behavior in the parameter file. | |
String | m_sXMLRootString = "" |
XML tag to surround this behavior's data. | |
String | m_sHelpFileString = "" |
Help file topic identifier string. | |
boolean[] | mp_bCanApplyToTreeType |
For each tree type, whether or not this behavior can be applied to it. | |
double | m_fVersion = 1.0 |
Version of this behavior. | |
double | m_fMinVersion = 1.0 |
Minimum version of this behavior. | |
int | m_iListPosition = -1 |
This behavior's position in the behavior list. | |
Private Member Functions | |
void | doSetup (TreePopulation oPop) throws ModelException |
Does setup of the enum vectors. | |
Additional Inherited Members | |
![]() | |
static void | initialize () |
Initializes the static members. | |
![]() | |
boolean | m_bMustHaveTrees = true |
If true, and a tree has no species/type combos, it automatically becomes disabled. | |
![]() | |
void | setSingleValue (ModelData oDataMember, Object oData) throws ModelException |
Sets the value of a single data member. | |
BehaviorParameterDisplay | formatTable (Vector< ModelData > p_oSingles, Vector< Vector< SpeciesSpecific >> p_oSpeciesSpecific, TreePopulation oPop) |
Turns vector groups of data objects into a set of tables for display. | |
![]() | |
static boolean | boolArraysEqual (boolean[] p_bArrayOne, boolean[] p_bArrayTwo) |
Tests two boolean arrays for equality. | |
![]() | |
static ModelVector | mp_fStandardDeviation |
Standard deviation if seed distribution method is normal or lognormal. | |
static ModelVector | mp_fClumpingParameter |
Clumping parameter if seed distribution is negative binomial. | |
static ModelEnum | m_iSeedDistributionMethod |
Seed distribution. | |
Corresponds to the clMastingNonSpatialDisperse class.
sortie.data.funcgroups.disperse.MastingNonSpatialDisperse.MastingNonSpatialDisperse | ( | GUIManager | oManager, |
BehaviorTypeBase | oParent, | ||
String | sDescriptor, | ||
String | sParFileTag, | ||
String | sXMLRootString | ||
) | throws ModelException |
Constructor.
oManager | GUIManager object |
oParent | Parent managing object. |
sDescriptor | The name of the behavior for the user. |
sParFileTag | String which is used to identify this behavior in the parameter file. |
sXMLRootString | XML tag to surround this behavior's data. |
ModelException |
void sortie.data.funcgroups.disperse.MastingNonSpatialDisperse.changeOfSpecies | ( | int | iOldNumSpecies, |
int[] | p_iIndexer, | ||
String[] | p_sNewSpecies | ||
) | throws ModelException |
Overridden to do enums.
|
private |
Does setup of the enum vectors.
oPop | TreePopulation object. |
ModelException | if there's a problem setting behavior use data. |
|
virtual |
Validates the data in preparation for parameter file writing or some such.
oPop | TreePopulation object. |
ModelException | if inverse gaussian mus and lambdas are negative |
Implements sortie.data.funcgroups.Behavior.
|
protected |
Masting non-spatial disperse - P parameter for binomial distribution for deciding whether to mast.
|
protected |
Masting non-spatial disperse - lambda parameter for inverse gaussian distribution - mast conditions.
|
protected |
Masting non-spatial disperse - mu parameter for inverse gaussian distribution - mast conditions.
|
protected |
Masting non-spatial disperse - mean for normal distribution - mast conditions.
|
protected |
Masting non-spatial disperse - standard deviation for normal distribution.
|
protected |
Masting non-spatial disperse - lambda parameter for inverse gaussian distribution - non-mast conditions.
|
protected |
Masting non-spatial disperse - mu parameter for inverse gaussian distribution - non-mast conditions.
|
protected |
Masting non-spatial disperse - mean for normal distribution - non-mast conditions.
|
protected |
Masting non-spatial disperse - standard deviation for normal distribution.
|
protected |
Masting non-spatial disperse - distribution function to pick seeds in mast conditions.
|
protected |
Masting non-spatial disperse - group identification for each species.
|
protected |
Masting non-spatial disperse - distribution function to pick seeds in non-mast conditions.