SORTIE Java Interface  1
Public Member Functions | Protected Attributes | List of all members
sortie.data.funcgroups.disturbance.Storm Class Reference

Corresponds to the clStorm class. More...

Inheritance diagram for sortie.data.funcgroups.disturbance.Storm:
sortie.data.funcgroups.Behavior

Public Member Functions

 Storm (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString) throws ModelException
 Constructor.
 
void validateData (TreePopulation oPop) throws ModelException
 Validates the data prior to writing it.
 
int getNumberStormEvents ()
 Gets number of storm events.
 
ScheduledStormInfo getStormEvent (int iIndex)
 Gets a particular storm event.
 
void clearStormEvents ()
 Clears storm events.
 
void addStormEvent (ScheduledStormInfo oEvent)
 Adds a storm event.
 
void writeXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException
 Writes the storm data to the parameter file.
 
String getSusceptibility ()
 Gets the susceptibility value.
 
void readXMLParentTag (String sXMLTag, Attributes oAttributes) throws ModelException
 Accepts an XML parent tag (empty, no data) from the parser.
 
- 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.
 
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

ModelFloat m_fClass1RtrnInt
 Storm return interval for 0-0.1 severity storm.
 
ModelFloat m_fClass2RtrnInt
 Storm return interval for 0.1-0.2 severity storm.
 
ModelFloat m_fClass3RtrnInt
 Storm return interval for 0.2-0.3 severity storm.
 
ModelFloat m_fClass4RtrnInt
 Storm return interval for 0.3-0.4 severity storm.
 
ModelFloat m_fClass5RtrnInt
 Storm return interval for 0.4-0.5 severity storm.
 
ModelFloat m_fClass6RtrnInt
 Storm return interval for 0.5-0.6 severity storm.
 
ModelFloat m_fClass7RtrnInt
 Storm return interval for 0.6-0.7 severity storm.
 
ModelFloat m_fClass8RtrnInt
 Storm return interval for 0.7-0.8 severity storm.
 
ModelFloat m_fClass9RtrnInt
 Storm return interval for 0.8-0.9 severity storm.
 
ModelFloat m_fClass10RtrnInt
 Storm return interval for 0.9-1.0 severity storm.
 
ModelFloat m_fStormSSTPeriod
 Storm - SST periodicity (Sr)
 
ModelFloat m_fStormSineD
 Storm - Sine function d.
 
ModelFloat m_fStormSineF
 Storm - Sine function f.
 
ModelFloat m_fStormSineG
 Storm - Sine function g.
 
ModelFloat m_fStormTrendSlopeM
 Storm - Trend function slope (m)
 
ModelFloat m_fStormTrendInterceptI
 Storm - Trend function intercept (i)
 
ModelEnum m_iSusceptibility
 Storm susceptibility pattern.
 
ModelEnum m_iStochasticity
 Storm stochasticity pattern.
 
ModelEnum m_iProbDistFunc
 Probability distribution function.
 
ModelFloat m_fStdDev
 Standard deviation for normal and lognormal stochastic storm damage functions.
 
Vector< ScheduledStormInfomp_oScheduledStorms = new Vector<ScheduledStormInfo>(0)
 List of scheduled storm events (objects of class ScheduledStormInfo)
 
- 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from sortie.data.funcgroups.Behavior
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.
 
- 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.
 

Detailed Description

Corresponds to the clStorm class.

Author
lora

Constructor & Destructor Documentation

sortie.data.funcgroups.disturbance.Storm.Storm ( GUIManager  oManager,
BehaviorTypeBase  oParent,
String  sDescriptor,
String  sParFileTag,
String  sXMLRootString 
) throws ModelException

Constructor.

Parameters
oManagerGUIManager object
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.
Exceptions
ModelExceptionWon't throw.

Member Function Documentation

void sortie.data.funcgroups.disturbance.Storm.addStormEvent ( ScheduledStormInfo  oEvent)

Adds a storm event.

Parameters
oEventEvent to add.
void sortie.data.funcgroups.disturbance.Storm.clearStormEvents ( )

Clears storm events.

int sortie.data.funcgroups.disturbance.Storm.getNumberStormEvents ( )

Gets number of storm events.

Returns
Number of storm events.
ScheduledStormInfo sortie.data.funcgroups.disturbance.Storm.getStormEvent ( int  iIndex)

Gets a particular storm event.

Parameters
iIndexIndex of desired storm event.
Returns
Desired storm event.
String sortie.data.funcgroups.disturbance.Storm.getSusceptibility ( )

Gets the susceptibility value.

Returns
The susceptibility value.
void sortie.data.funcgroups.disturbance.Storm.readXMLParentTag ( String  sXMLTag,
Attributes  oAttributes 
) throws ModelException

Accepts an XML parent tag (empty, no data) from the parser.

This method watches for the st_stmEvent tags.

Parameters
sXMLTagThe XML tag.
oAttributesThe attributes of this object.
Exceptions
ModelExceptionif there is a problem reading this data.
void sortie.data.funcgroups.disturbance.Storm.validateData ( TreePopulation  oPop) throws ModelException
virtual

Validates the data prior to writing it.

This will also double check grid cell size and update disturbance events as appropriate in case cell size has been changed.

Parameters
oPopTreePopulation object
Exceptions
ModelExceptionif:
  • If the Storms behavior is enabled, this makes sure that all storm return intervals are greater than 0.
  • If the Storms behavior is enabled and the susceptibility is set to "mapped", this makes sure that there are values for the grid object "Storm Susceptibility" and they are greater than 0.
  • If the Storms behavior is enabled and the damage pattern is set to "mapped", this makes sure that the grid resolution for the "Storm Susceptibility" and "Storm Damage" grids is the same.

Implements sortie.data.funcgroups.Behavior.

void sortie.data.funcgroups.disturbance.Storm.writeXML ( BufferedWriter  jOut,
TreePopulation  oPop 
) throws ModelException

Writes the storm data to the parameter file.

This is special because of scheduled storm events.

Parameters
jOutFileWriter File to write to.
oPopTree population object.
Exceptions
ModelExceptionpassed through from called functions.

Member Data Documentation

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass10RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.9 - 1.0",
"st_s10ReturnInterval")

Storm return interval for 0.9-1.0 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass1RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0 - 0.1", "st_s1ReturnInterval")

Storm return interval for 0-0.1 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass2RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.1 - 0.2",
"st_s2ReturnInterval")

Storm return interval for 0.1-0.2 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass3RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.2 - 0.3",
"st_s3ReturnInterval")

Storm return interval for 0.2-0.3 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass4RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.3 - 0.4",
"st_s4ReturnInterval")

Storm return interval for 0.3-0.4 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass5RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.4 - 0.5",
"st_s5ReturnInterval")

Storm return interval for 0.4-0.5 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass6RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.5 - 0.6",
"st_s6ReturnInterval")

Storm return interval for 0.5-0.6 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass7RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.6 - 0.7",
"st_s7ReturnInterval")

Storm return interval for 0.6-0.7 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass8RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.7 - 0.8",
"st_s8ReturnInterval")

Storm return interval for 0.7-0.8 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fClass9RtrnInt
protected
Initial value:
= new ModelFloat(0,
"Return Interval for Severity Storm Class 0.8 - 0.9",
"st_s9ReturnInterval")

Storm return interval for 0.8-0.9 severity storm.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fStdDev
protected
Initial value:
= new ModelFloat(0,
"Standard Deviation (lognormal or normal)", "st_standardDeviation")

Standard deviation for normal and lognormal stochastic storm damage functions.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fStormSineD
protected
Initial value:
= new ModelFloat(0,
"Storm - Storm Cyclicity Sine Curve d", "st_stmSineD")

Storm - Sine function d.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fStormSineF
protected
Initial value:
= new ModelFloat(1,
"Storm - Storm Cyclicity Sine Curve f", "st_stmSineF")

Storm - Sine function f.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fStormSineG
protected
Initial value:
= new ModelFloat(1,
"Storm - Storm Cyclicity Sine Curve g", "st_stmSineG")

Storm - Sine function g.

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fStormSSTPeriod
protected
Initial value:
= new ModelFloat(1,
"Storm - Sea Surface Temperature Cyclicity Period (Years)",
"st_stmSSTPeriod")

Storm - SST periodicity (Sr)

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fStormTrendInterceptI
protected
Initial value:
= new ModelFloat(1,
"Storm - Storm Cyclicity Trend Function Intercept (i)",
"st_stmTrendInterceptI")

Storm - Trend function intercept (i)

ModelFloat sortie.data.funcgroups.disturbance.Storm.m_fStormTrendSlopeM
protected
Initial value:
= new ModelFloat(0,
"Storm - Storm Cyclicity Trend Function Slope (m)", "st_stmTrendSlopeM")

Storm - Trend function slope (m)

ModelEnum sortie.data.funcgroups.disturbance.Storm.m_iProbDistFunc
protected
Initial value:
= new ModelEnum(new int[] { 0, 1 },
new String[] { "Lognormal", "Normal" },
"Stochastic Pattern Damage Distribution", "st_probFunction")

Probability distribution function.

ModelEnum sortie.data.funcgroups.disturbance.Storm.m_iStochasticity
protected
Initial value:
= new ModelEnum(new int[] { 0, 1 },
new String[] { "Deterministic", "Stochastic" },
"Storm Damage Application", "st_stochasticity")

Storm stochasticity pattern.

ModelEnum sortie.data.funcgroups.disturbance.Storm.m_iSusceptibility
protected
Initial value:
= new ModelEnum(new int[] { 0, 1 },
new String[] { "Mapped", "Uniform" },
"Plot Storm Susceptibility Pattern", "st_susceptibility")

Storm susceptibility pattern.

Vector<ScheduledStormInfo> sortie.data.funcgroups.disturbance.Storm.mp_oScheduledStorms = new Vector<ScheduledStormInfo>(0)
protected

List of scheduled storm events (objects of class ScheduledStormInfo)


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