SORTIE Java Interface
1
|
Corresponds to the clSnagDecomp class. More...
Public Member Functions | |
SnagDecayClassDynamics (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString) throws ModelException | |
Constructor. | |
void | validateData (TreePopulation oPop) throws ModelException |
Validates the data in preparation for parameter file writing or some such. | |
![]() | |
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_fSnagDecompTreeFallBeta |
Snag Decay Class Dynamics Tree Fall Beta Parameter, species-specific. | |
ModelVector | mp_fSnagDecompSnagFallBeta |
Snag Decay Class Dynamics Snag Fall Beta Parameter, species-specific. | |
ModelFloat | m_fSnagDecompTreeFallAlpha |
Snag Decay Class Dynamics Tree Fall Alpha Parameter. | |
ModelFloat | m_fSnagDecompTreeFallDelta |
Snag Decay Class Dynamics Tree Fall Delta Parameter. | |
ModelFloat | m_fSnagDecompTreeFallTheta |
Snag Decay Class Dynamics Tree Fall Theta Parameter. | |
ModelFloat | m_fSnagDecompTreeFallIota |
Snag Decay Class Dynamics Tree Fall Iota Parameter. | |
ModelFloat | m_fSnagDecompTreeFallLambda |
Snag Decay Class Dynamics Tree Fall Lambda Parameter. | |
ModelFloat | m_fSnagDecompSnagFallAlpha |
Snag Decay Class Dynamics Snag Fall Alpha Parameter. | |
ModelFloat | m_fSnagDecompSnagFallGamma2 |
Snag Decay Class Dynamics Snag Fall Gamma 2 Parameter. | |
ModelFloat | m_fSnagDecompSnagFallGamma3 |
Snag Decay Class Dynamics Snag Fall Gamma 3 Parameter. | |
ModelFloat | m_fSnagDecompSnagFallGamma4 |
Snag Decay Class Dynamics Snag Fall Gamma 4 Parameter. | |
ModelFloat | m_fSnagDecompSnagFallGamma5 |
Snag Decay Class Dynamics Snag Fall Gamma 5 Parameter. | |
ModelFloat | m_fSnagDecompSnagFallZeta |
Snag Decay Class Dynamics Snag Fall Zeta Parameter. | |
ModelFloat | m_fSnagDecompSnagFallEta |
Snag Decay Class Dynamics Snag Fall Eta Parameter. | |
ModelFloat | m_fSnagDecompSnagFallKappa |
Snag Decay Class Dynamics Snag Fall Kappa Parameter. | |
ModelFloat | m_fSnagDecompLiveTo1Prob |
Snag Decay Class Dynamics Live To One Transition Probability. | |
ModelFloat | m_fSnagDecompLiveTo2Prob |
Snag Decay Class Dynamics Live To Two Transition Probability. | |
ModelFloat | m_fSnagDecompLiveTo3Prob |
Snag Decay Class Dynamics Live To Three Transition Probability. | |
ModelFloat | m_fSnagDecompLiveTo4Prob |
Snag Decay Class Dynamics Live To Four Transition Probability. | |
ModelFloat | m_fSnagDecompLiveTo5Prob |
Snag Decay Class Dynamics Live To Five Transition Probability. | |
ModelFloat | m_fSnagDecomp1To1Prob |
Snag Decay Class Dynamics One To One Transition Probability. | |
ModelFloat | m_fSnagDecomp1To2Prob |
Snag Decay Class Dynamics One To Two Transition Probability. | |
ModelFloat | m_fSnagDecomp1To3Prob |
Snag Decay Class Dynamics One To Three Transition Probability. | |
ModelFloat | m_fSnagDecomp1To4Prob |
Snag Decay Class Dynamics One To Four Transition Probability. | |
ModelFloat | m_fSnagDecomp1To5Prob |
Snag Decay Class Dynamics One To Five Transition Probability. | |
ModelFloat | m_fSnagDecomp2To2Prob |
Snag Decay Class Dynamics Two To Two Transition Probability. | |
ModelFloat | m_fSnagDecomp2To3Prob |
Snag Decay Class Dynamics Two To Three Transition Probability. | |
ModelFloat | m_fSnagDecomp2To4Prob |
Snag Decay Class Dynamics Two To Four Transition Probability. | |
ModelFloat | m_fSnagDecomp2To5Prob |
Snag Decay Class Dynamics Two To Five Transition Probability. | |
ModelFloat | m_fSnagDecomp3To3Prob |
Snag Decay Class Dynamics Three To Three Transition Probability. | |
ModelFloat | m_fSnagDecomp3To4Prob |
Snag Decay Class Dynamics Three To Four Transition Probability. | |
ModelFloat | m_fSnagDecomp3To5Prob |
Snag Decay Class Dynamics Three To Five Transition Probability. | |
ModelFloat | m_fSnagDecomp4To4Prob |
Snag Decay Class Dynamics Four To Four Transition Probability. | |
ModelFloat | m_fSnagDecomp4To5Prob |
Snag Decay Class Dynamics Four To Five Transition Probability. | |
ModelFloat | m_fSnagDecomp5To5Prob |
Snag Decay Class Dynamics Five To Five Transition Probability. | |
ModelFloat | m_fSnagDecompMinSnagBreakHeight |
Snag Decay Class Dynamics minimum snag break height. | |
ModelFloat | m_fSnagDecompMaxSnagBreakHeight |
Snag Decay Class Dynamics maximum snag break height. | |
![]() | |
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. | |
Additional Inherited Members | |
![]() | |
static void | writeDataToFile (BufferedWriter ojOut, ModelData oData) throws java.io. IOException |
Writes a piece of data to an XML file. | |
static Object[] | formatBlankHeaderRow (Object[][] p_oTable) |
Creates a blank header row for a table. | |
static Object[][] | formatDataAsComboBox (Object[][] p_oExisting, ModelEnum oToFormat) |
Adds a value with combo box formatting to an Object array for display in a JTable. | |
static String | formatComboBoxString (ModelEnum oToFormat) |
Formats a combo box string from a ModelEnum. | |
static void | addDataObjectToDisplayArrays (ModelData p_oDataObject, Vector< ModelData > p_oSingles, Vector< Vector< SpeciesSpecific >> p_oSpeciesSpecific, boolean[] p_bAppliesTo) |
Adds a data object to the arrays which will eventually display run parameters in a set of tables. | |
static Object[][] | addDataToArray (Object[][] p_oExistingArray, Object[] p_oAddArray) |
Adds an Object array to an existing Object array. | |
static Object[][] | formatDataForTable (Object[][] p_oExisting, ModelFloat oToFormat) |
Formats and adds a value into an Object array suitable for placing in a JTable. | |
static Object[][] | formatDataForTable (Object[][] p_oExisting, ModelInt oToFormat) |
Formats and adds a value into an Object array suitable for placing in a JTable. | |
static Object[][] | formatDataForTable (Object[][] p_oExisting, ModelString oToFormat) |
Formats and adds a value into an Object array suitable for placing in a JTable. | |
static Object[][] | formatDataForTable (Object[][] p_oExisting, ModelVector oToFormat) |
Formats a vector of values into an object array and adds it to another Object array suitable for placing in a JTable. | |
static Object[][] | formatDataForTable (Object[][] p_oExisting, ModelVector oToFormat, boolean[] p_bWhichSpecies) |
Formats a vector of values into a plain vector suitable for placing in a JTable and adds it to a vector of vectors at the end. | |
static Object[] | formatSpeciesHeaderRow (boolean[] p_bUsed, TreePopulation oPop) |
Creates an object array of strings consisting of species names, suitable for including in the parameter entry table. | |
![]() | |
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. | |
Corresponds to the clSnagDecomp class.
sortie.data.funcgroups.snagdynamics.SnagDecayClassDynamics.SnagDecayClassDynamics | ( | 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 |
|
virtual |
Validates the data in preparation for parameter file writing or some such.
ModelException | if any of the probabilities are not proportions, or if the probabilities for a class don't add up to 1. |
oPop | Not used. |
Implements sortie.data.funcgroups.Behavior.
|
protected |
Snag Decay Class Dynamics One To One Transition Probability.
|
protected |
Snag Decay Class Dynamics One To Two Transition Probability.
|
protected |
Snag Decay Class Dynamics One To Three Transition Probability.
|
protected |
Snag Decay Class Dynamics One To Four Transition Probability.
|
protected |
Snag Decay Class Dynamics One To Five Transition Probability.
|
protected |
Snag Decay Class Dynamics Two To Two Transition Probability.
|
protected |
Snag Decay Class Dynamics Two To Three Transition Probability.
|
protected |
Snag Decay Class Dynamics Two To Four Transition Probability.
|
protected |
Snag Decay Class Dynamics Two To Five Transition Probability.
|
protected |
Snag Decay Class Dynamics Three To Three Transition Probability.
|
protected |
Snag Decay Class Dynamics Three To Four Transition Probability.
|
protected |
Snag Decay Class Dynamics Three To Five Transition Probability.
|
protected |
Snag Decay Class Dynamics Four To Four Transition Probability.
|
protected |
Snag Decay Class Dynamics Four To Five Transition Probability.
|
protected |
Snag Decay Class Dynamics Five To Five Transition Probability.
|
protected |
Snag Decay Class Dynamics Live To One Transition Probability.
|
protected |
Snag Decay Class Dynamics Live To Two Transition Probability.
|
protected |
Snag Decay Class Dynamics Live To Three Transition Probability.
|
protected |
Snag Decay Class Dynamics Live To Four Transition Probability.
|
protected |
Snag Decay Class Dynamics Live To Five Transition Probability.
|
protected |
Snag Decay Class Dynamics maximum snag break height.
|
protected |
Snag Decay Class Dynamics minimum snag break height.
|
protected |
Snag Decay Class Dynamics Snag Fall Alpha Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Eta Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Gamma 2 Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Gamma 3 Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Gamma 4 Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Gamma 5 Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Kappa Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Zeta Parameter.
|
protected |
Snag Decay Class Dynamics Tree Fall Alpha Parameter.
|
protected |
Snag Decay Class Dynamics Tree Fall Delta Parameter.
|
protected |
Snag Decay Class Dynamics Tree Fall Iota Parameter.
|
protected |
Snag Decay Class Dynamics Tree Fall Lambda Parameter.
|
protected |
Snag Decay Class Dynamics Tree Fall Theta Parameter.
|
protected |
Snag Decay Class Dynamics Snag Fall Beta Parameter, species-specific.
|
protected |
Snag Decay Class Dynamics Tree Fall Beta Parameter, species-specific.