This class packages together a set of tree settings. More...
Inheritance diagram for sortie.data.simpletypes.DetailedTreeSettings:
Public Member Functions | |
| DetailedTreeSettings (int iType, int iSpecies) | |
| Constructor. More... | |
| DetailedTreeSettings (int iType, int iSpecies, int iDeadCode) | |
| Constructor. More... | |
| int | getSpecies () |
| Gets the tree species. More... | |
| void | setSpecies (int iNewSpecies) |
| Sets the tree species. More... | |
| int | getDeadCode () |
| Gets the dead code. More... | |
| int | getType () |
| Gets the tree type. More... | |
| Object | clone () |
| Creates a deep clone of this object. More... | |
 Public Member Functions inherited from sortie.data.simpletypes.DetailedOutputSettings | |
| int | getSaveFrequency () |
| Gets the save frequency. More... | |
| void | setSaveFrequency (int i) |
| Sets the save frequency. More... | |
| void | addFloat (String sCodeName, String sDisplayName) |
| Add a new float data member. More... | |
| void | addInt (String sCodeName, String sDisplayName) |
| Add a new int data member. More... | |
| void | addBool (String sCodeName, String sDisplayName) |
| Add a new bool data member. More... | |
| void | addChar (String sCodeName, String sDisplayName) |
| Add a new char data member. More... | |
| int | getNumberOfFloats () |
| Get the number of float data members. More... | |
| int | getNumberOfInts () |
| Get the number of int data members. More... | |
| int | getNumberOfChars () |
| Get the number of char data members. More... | |
| int | getNumberOfBools () |
| Get the number of bool data members. More... | |
| void | removeInt (int i) |
| Removes an integer data member. More... | |
| void | removeFloat (int i) |
| Removes a float data member. More... | |
| void | removeBool (int i) |
| Removes a boolean data member. More... | |
| void | removeChar (int i) |
| Removes a char data member. More... | |
| DataMember | getFloat (int iIndex) |
| Gets a float data member. More... | |
| DataMember | getInt (int iIndex) |
| Get the label of an int data member. More... | |
| DataMember | getChar (int iIndex) |
| Get the label of a char data member. More... | |
| DataMember | getBool (int iIndex) |
| Gets a bool data member. More... | |
Private Attributes | |
| int | m_iType |
| Tree type. More... | |
| int | m_iSpecies |
| Tree species. More... | |
| int | m_iDeadCode |
| Dead reason code - can be not dead. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from sortie.data.simpletypes.DetailedOutputSettings | |
| static void | copyData (DetailedOutputSettings oCopyTarget, DetailedOutputSettings oCopySource) |
| Copies data members from one DetailedOutputSettings object to another. More... | |
| Protected Attributes inherited from sortie.data.simpletypes.DetailedOutputSettings | |
| ArrayList< DataMember > | mp_oFloats = new ArrayList<DataMember>(0) |
| Vector of DataMembers representing floats. More... | |
| int | m_iSaveFreq = 0 |
| Save frequency, in timesteps. More... | |
Detailed Description
This class packages together a set of tree settings.
For a given species and tree type, this will tell you what is available in a tree map (or detailed output file).
Copyright: Copyright (c) Charles D. Canham 2003
Company: Cary Institute of Ecosystem Studies
- Version
- 1.0
Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)
February 1, 2011: Added support for dead trees (LEM)
Constructor & Destructor Documentation
◆ DetailedTreeSettings() [1/2]
| sortie.data.simpletypes.DetailedTreeSettings.DetailedTreeSettings | ( | int | iType, |
| int | iSpecies | ||
| ) |
Constructor.
- Parameters
-
iType Tree type. iSpecies Tree species.
◆ DetailedTreeSettings() [2/2]
| sortie.data.simpletypes.DetailedTreeSettings.DetailedTreeSettings | ( | int | iType, |
| int | iSpecies, | ||
| int | iDeadCode | ||
| ) |
Constructor.
- Parameters
-
iType Tree type. iSpecies Tree species. iDeadCode Valid dead reason code from output behaviors.
Member Function Documentation
◆ clone()
| Object sortie.data.simpletypes.DetailedTreeSettings.clone | ( | ) |
Creates a deep clone of this object.
- Returns
- Clone.
◆ getDeadCode()
| int sortie.data.simpletypes.DetailedTreeSettings.getDeadCode | ( | ) |
Gets the dead code.
- Returns
- The dead code.
◆ getSpecies()
| int sortie.data.simpletypes.DetailedTreeSettings.getSpecies | ( | ) |
Gets the tree species.
- Returns
- Tree species.
◆ getType()
| int sortie.data.simpletypes.DetailedTreeSettings.getType | ( | ) |
Gets the tree type.
- Returns
- Tree type.
◆ setSpecies()
| void sortie.data.simpletypes.DetailedTreeSettings.setSpecies | ( | int | iNewSpecies | ) |
Sets the tree species.
- Parameters
-
iNewSpecies Tree species.
Member Data Documentation
◆ m_iDeadCode
|
private |
Dead reason code - can be not dead.
◆ m_iSpecies
|
private |
Tree species.
◆ m_iType
|
private |
Tree type.
The documentation for this class was generated from the following file:
