SORTIE Java Interface  1
Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | List of all members
sortie.data.funcgroups.disperse.SpatialDisperseBase Class Reference

Corresponds to the clSpatialDispersal class. More...

Inheritance diagram for sortie.data.funcgroups.disperse.SpatialDisperseBase:
sortie.data.funcgroups.disperse.DisperseBase sortie.data.funcgroups.Behavior sortie.data.funcgroups.disperse.GapSpatialDisperse sortie.data.funcgroups.disperse.MastingSpatialDisperse sortie.data.funcgroups.disperse.NonGapSpatialDisperse

Public Member Functions

 SpatialDisperseBase (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString)
 Constructor.
 
void changeOfSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies) throws ModelException
 Overridden to redo the enums.
 
- Public Member Functions inherited from sortie.data.funcgroups.disperse.DisperseBase
 DisperseBase (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString)
 Constructor.
 
- Public Member Functions inherited from sortie.data.funcgroups.Behavior
GUIManager getGUIManager ()
 
 Behavior (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString)
 Constructor.
 
abstract void validateData (TreePopulation oPop) throws ModelException
 Override this to implement data checking.
 
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.
 

Static Public Attributes

static final int WEIBULL = 0
 Weibull disperse function.
 
static final int LOGNORMAL = 1
 Lognormal disperse function.
 
static final int CANOPY = 0
 Canopy forest cover status for cells.
 
static final int GAP = 1
 Gap forest cover status for cells.
 
static final int NUMBER_OF_DISPERSE_FUNCTIONS = 2
 Total number of disperse functions.
 
static final int NUMBER_OF_FOREST_COVERS = 2
 Total number of forest cover statuses.
 

Protected Attributes

ModelVector[][] mp_fSTR
 STR for disperse function.
 
ModelVector[][] mp_fBeta
 Beta for disperse function.
 
ModelVector[][] mp_fThetaOrXb
 Theta (if weibull) or Xb (if lognormal) for disperse function.
 
ModelVector[][] mp_fDispOrX0
 Dispersal (if weibull) or X0 (if lognormal) for disperse function.
 
ModelVector[] mp_iWhichFunctionUsed
 Which disperse function to use under each forest cover - valid values are WEIBULL and LOGNORMAL - this is a vector of ModelEnums.
 
ModelVector mp_fStumpSTR
 STR for stump dispersal for each species.
 
ModelVector mp_fStumpBeta
 Beta for stump dispersal for each species.
 
- Protected Attributes inherited from sortie.data.funcgroups.disperse.DisperseBase
ModelVector mp_fMinDbhForReproduction
 Minimum DBH for reproduction for each species.
 
- Protected Attributes inherited from sortie.data.funcgroups.Behavior
GUIManager m_oManager
 GUIManager object.
 
BehaviorTypeBase m_oParent
 Parent manager.
 
Vector< ModelDatamp_oAllData = new Vector<ModelData>()
 All data for this object.
 
Vector< SpeciesTypeCombomp_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< DataMembermp_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)
 Does setup of enum vectors.
 

Additional Inherited Members

- Static Public Member Functions inherited from sortie.data.funcgroups.disperse.DisperseBase
static void initialize ()
 Initializes the static members.
 
- Public Attributes inherited from sortie.data.funcgroups.Behavior
boolean m_bMustHaveTrees = true
 If true, and a tree has no species/type combos, it automatically becomes disabled.
 
- Protected Member Functions inherited from sortie.data.funcgroups.Behavior
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 Protected Member Functions inherited from sortie.data.funcgroups.Behavior
static boolean boolArraysEqual (boolean[] p_bArrayOne, boolean[] p_bArrayTwo)
 Tests two boolean arrays for equality.
 
- Static Protected Attributes inherited from sortie.data.funcgroups.disperse.DisperseBase
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.
 

Detailed Description

Corresponds to the clSpatialDispersal class.

Author
lora

Constructor & Destructor Documentation

sortie.data.funcgroups.disperse.SpatialDisperseBase.SpatialDisperseBase ( GUIManager  oManager,
BehaviorTypeBase  oParent,
String  sDescriptor,
String  sParFileTag,
String  sXMLRootString,
String  sHelpFileString 
)

Constructor.

Parameters
oManagerGUI manager.
oParentParent managing object.
sDescriptorThe name of the behavior for the user.
sParFileTagString which is used to identify this behavior in the parameter file.
sXMLRootStringXML tag to surround this behavior's data.
sHelpFileStringString matching this behavior's topic in the help
Exceptions
ModelException

Member Function Documentation

void sortie.data.funcgroups.disperse.SpatialDisperseBase.changeOfSpecies ( int  iOldNumSpecies,
int[]  p_iIndexer,
String[]  p_sNewSpecies 
) throws ModelException

Overridden to redo the enums.

void sortie.data.funcgroups.disperse.SpatialDisperseBase.doSetup ( TreePopulation  oPop)
private

Does setup of enum vectors.

Parameters
oPopTreePopulation object.
Exceptions
ModelExceptionif there's a problem setting behavior use data.

Member Data Documentation

final int sortie.data.funcgroups.disperse.SpatialDisperseBase.CANOPY = 0
static

Canopy forest cover status for cells.

final int sortie.data.funcgroups.disperse.SpatialDisperseBase.GAP = 1
static

Gap forest cover status for cells.

final int sortie.data.funcgroups.disperse.SpatialDisperseBase.LOGNORMAL = 1
static

Lognormal disperse function.

ModelVector [][] sortie.data.funcgroups.disperse.SpatialDisperseBase.mp_fBeta
protected

Beta for disperse function.

Array is 3D - first index is which disperse function is used - weibull or lognormal. The second index is cover - canopy or gap. The third index is species.

ModelVector [][] sortie.data.funcgroups.disperse.SpatialDisperseBase.mp_fDispOrX0
protected

Dispersal (if weibull) or X0 (if lognormal) for disperse function.

Array is 3D - first index is which disperse function is used - weibull or lognormal. The second index is cover - canopy or gap. The third index is species.

ModelVector [][] sortie.data.funcgroups.disperse.SpatialDisperseBase.mp_fSTR
protected

STR for disperse function.

Array is 3D - first index is which disperse function is used - weibull or lognormal. The second index is cover - canopy or gap. The third index is species.

ModelVector sortie.data.funcgroups.disperse.SpatialDisperseBase.mp_fStumpBeta
protected
Initial value:
= new ModelVector("Beta for Stumps",
"di_suckerBeta", "di_sbVal", 0, ModelVector.FLOAT)

Beta for stump dispersal for each species.

ModelVector sortie.data.funcgroups.disperse.SpatialDisperseBase.mp_fStumpSTR
protected
Initial value:
= new ModelVector("STR for Stumps",
"di_suckerSTR", "di_ssVal", 0, ModelVector.FLOAT)

STR for stump dispersal for each species.

ModelVector [][] sortie.data.funcgroups.disperse.SpatialDisperseBase.mp_fThetaOrXb
protected

Theta (if weibull) or Xb (if lognormal) for disperse function.

Array is 3D - first index is which disperse function is used - weibull or lognormal. The second index is cover - canopy or gap. The third index is species.

ModelVector [] sortie.data.funcgroups.disperse.SpatialDisperseBase.mp_iWhichFunctionUsed
protected

Which disperse function to use under each forest cover - valid values are WEIBULL and LOGNORMAL - this is a vector of ModelEnums.

final int sortie.data.funcgroups.disperse.SpatialDisperseBase.NUMBER_OF_DISPERSE_FUNCTIONS = 2
static

Total number of disperse functions.

final int sortie.data.funcgroups.disperse.SpatialDisperseBase.NUMBER_OF_FOREST_COVERS = 2
static

Total number of forest cover statuses.

final int sortie.data.funcgroups.disperse.SpatialDisperseBase.WEIBULL = 0
static

Weibull disperse function.


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