|
SORTIE Java Interface
1
|
Base class for detailed output settings. More...
Public Member Functions | |
| int | getSaveFrequency () |
| Gets the save frequency. | |
| void | setSaveFrequency (int i) |
| Sets the save frequency. | |
| void | addFloat (String sCodeName, String sDisplayName) |
| Add a new float data member. | |
| void | addInt (String sCodeName, String sDisplayName) |
| Add a new int data member. | |
| void | addBool (String sCodeName, String sDisplayName) |
| Add a new bool data member. | |
| void | addChar (String sCodeName, String sDisplayName) |
| Add a new char data member. | |
| int | getNumberOfFloats () |
| Get the number of float data members. | |
| int | getNumberOfInts () |
| Get the number of int data members. | |
| int | getNumberOfChars () |
| Get the number of char data members. | |
| int | getNumberOfBools () |
| Get the number of bool data members. | |
| void | removeInt (int i) |
| Removes an integer data member. | |
| void | removeFloat (int i) |
| Removes a float data member. | |
| void | removeBool (int i) |
| Removes a boolean data member. | |
| void | removeChar (int i) |
| Removes a char data member. | |
| DataMember | getFloat (int iIndex) |
| Gets a float data member. | |
| DataMember | getInt (int iIndex) |
| Get the label of an int data member. | |
| DataMember | getChar (int iIndex) |
| Get the label of a char data member. | |
| DataMember | getBool (int iIndex) |
| Gets a bool data member. | |
Static Public Member Functions | |
| static void | copyData (DetailedOutputSettings oCopyTarget, DetailedOutputSettings oCopySource) |
| Copies data members from one DetailedOutputSettings object to another. | |
Protected Attributes | |
| Vector< DataMember > | mp_oFloats = new Vector<DataMember>(0) |
| Vector of DataMembers representing floats. | |
| int | m_iSaveFreq = 0 |
| Save frequency, in timesteps. | |
Base class for detailed output settings.
Copyright: Copyright (c) Charles D. Canham 2003
Company: Cary Institute of Ecosystem Studies
Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)
| void sortie.data.simpletypes.DetailedOutputSettings.addBool | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new bool data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
| void sortie.data.simpletypes.DetailedOutputSettings.addChar | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new char data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
| void sortie.data.simpletypes.DetailedOutputSettings.addFloat | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new float data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
| void sortie.data.simpletypes.DetailedOutputSettings.addInt | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new int data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
|
static |
Copies data members from one DetailedOutputSettings object to another.
This can be used to create deep clones.
| oCopyTarget | Object to which to copy settings |
| oCopySource | Object from which to copy settings. |
| DataMember sortie.data.simpletypes.DetailedOutputSettings.getBool | ( | int | iIndex | ) |
Gets a bool data member.
| iIndex | of the bool data member |
| DataMember sortie.data.simpletypes.DetailedOutputSettings.getChar | ( | int | iIndex | ) |
Get the label of a char data member.
| iIndex | of the char data member |
| DataMember sortie.data.simpletypes.DetailedOutputSettings.getFloat | ( | int | iIndex | ) |
Gets a float data member.
| iIndex | of the float data member |
| DataMember sortie.data.simpletypes.DetailedOutputSettings.getInt | ( | int | iIndex | ) |
Get the label of an int data member.
| iIndex | of the int data member |
| int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfBools | ( | ) |
Get the number of bool data members.
| int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfChars | ( | ) |
Get the number of char data members.
| int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfFloats | ( | ) |
Get the number of float data members.
| int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfInts | ( | ) |
Get the number of int data members.
| int sortie.data.simpletypes.DetailedOutputSettings.getSaveFrequency | ( | ) |
Gets the save frequency.
| void sortie.data.simpletypes.DetailedOutputSettings.removeBool | ( | int | i | ) |
Removes a boolean data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedOutputSettings.removeChar | ( | int | i | ) |
Removes a char data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedOutputSettings.removeFloat | ( | int | i | ) |
Removes a float data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedOutputSettings.removeInt | ( | int | i | ) |
Removes an integer data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedOutputSettings.setSaveFrequency | ( | int | i | ) |
Sets the save frequency.
| i | Save frequency, in timesteps. |
|
protected |
Save frequency, in timesteps.
|
protected |
Vector of DataMembers representing floats.
1.8.2