|
SORTIE Java Interface
1
|
Captures the output settings for a single grid. More...
Public Member Functions | |
| DetailedGridSettings (String sName) | |
| Constructor. | |
| String | getName () |
| Get the name of this grid. | |
| void | setXCellLength (float fValue) |
| Sets the X cell length. | |
| void | setYCellLength (float fValue) |
| Sets the Y cell length. | |
| float | getXCellLength () |
| Gets the X cell length. | |
| float | getYCellLength () |
| Gets the Y cell length. | |
| void | addPackageFloat (String sCodeName, String sDisplayName) |
| Add a new package float data member. | |
| void | addPackageInt (String sCodeName, String sDisplayName) |
| Add a new package int data member. | |
| void | addPackageBool (String sCodeName, String sDisplayName) |
| Add a new package bool data member. | |
| void | addPackageChar (String sCodeName, String sDisplayName) |
| Add a new package char data member. | |
| int | getNumberOfPackageFloats () |
| Get the number of package float data members. | |
| int | getNumberOfPackageInts () |
| Get the number of package int data members. | |
| int | getNumberOfPackageChars () |
| Get the number of package char data members. | |
| int | getNumberOfPackageBools () |
| Get the number of package bool data members. | |
| void | removePackageInt (int i) |
| Removes a package integer data member. | |
| void | removePackageFloat (int i) |
| Removes a package float data member. | |
| void | removePackageBool (int i) |
| Removes a package boolean data member. | |
| void | removePackageChar (int i) |
| Removes a package char data member. | |
| DataMember | getPackageFloat (int iIndex) |
| Gets a package float data member. | |
| DataMember | getPackageInt (int iIndex) |
| Get the label of an package int data member. | |
| DataMember | getPackageChar (int iIndex) |
| Get the label of a package char data member. | |
| DataMember | getPackageBool (int iIndex) |
| Gets a package bool data member. | |
| Object | clone () |
| Creates a deep clone of this object. | |
Public Member Functions inherited from sortie.data.simpletypes.DetailedOutputSettings | |
| 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. | |
Protected Attributes | |
| Vector< DataMember > | mp_oPackageFloats = new Vector<DataMember>(0) |
| Vector of DataMembers representing package floats. | |
Protected Attributes inherited from sortie.data.simpletypes.DetailedOutputSettings | |
| Vector< DataMember > | mp_oFloats = new Vector<DataMember>(0) |
| Vector of DataMembers representing floats. | |
| int | m_iSaveFreq = 0 |
| Save frequency, in timesteps. | |
Private Attributes | |
| String | m_sName |
| Grid name. | |
| float | m_fXCellLength |
| Length of grid cells in X direction, in m. | |
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. | |
Captures the output settings for a single grid.
This is used in two ways: when a user is setting up detailed output options, and when the data visualizer is working with grids.
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)
| sortie.data.simpletypes.DetailedGridSettings.DetailedGridSettings | ( | String | sName | ) |
Constructor.
| sName | Grid name. |
| void sortie.data.simpletypes.DetailedGridSettings.addPackageBool | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new package bool data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
| void sortie.data.simpletypes.DetailedGridSettings.addPackageChar | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new package char data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
| void sortie.data.simpletypes.DetailedGridSettings.addPackageFloat | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new package float data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
| void sortie.data.simpletypes.DetailedGridSettings.addPackageInt | ( | String | sCodeName, |
| String | sDisplayName | ||
| ) |
Add a new package int data member.
If it already exists it won't be added again.
| sCodeName | Code name. |
| sDisplayName | Display name. |
| Object sortie.data.simpletypes.DetailedGridSettings.clone | ( | ) |
Creates a deep clone of this object.
| String sortie.data.simpletypes.DetailedGridSettings.getName | ( | ) |
Get the name of this grid.
| int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageBools | ( | ) |
Get the number of package bool data members.
| int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageChars | ( | ) |
Get the number of package char data members.
| int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageFloats | ( | ) |
Get the number of package float data members.
| int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageInts | ( | ) |
Get the number of package int data members.
| DataMember sortie.data.simpletypes.DetailedGridSettings.getPackageBool | ( | int | iIndex | ) |
Gets a package bool data member.
| iIndex | of the package bool data member |
| DataMember sortie.data.simpletypes.DetailedGridSettings.getPackageChar | ( | int | iIndex | ) |
Get the label of a package char data member.
| iIndex | of the package char data member |
| DataMember sortie.data.simpletypes.DetailedGridSettings.getPackageFloat | ( | int | iIndex | ) |
Gets a package float data member.
| iIndex | of the package float data member |
| DataMember sortie.data.simpletypes.DetailedGridSettings.getPackageInt | ( | int | iIndex | ) |
Get the label of an package int data member.
| iIndex | of the package int data member |
| float sortie.data.simpletypes.DetailedGridSettings.getXCellLength | ( | ) |
Gets the X cell length.
| float sortie.data.simpletypes.DetailedGridSettings.getYCellLength | ( | ) |
Gets the Y cell length.
| void sortie.data.simpletypes.DetailedGridSettings.removePackageBool | ( | int | i | ) |
Removes a package boolean data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedGridSettings.removePackageChar | ( | int | i | ) |
Removes a package char data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedGridSettings.removePackageFloat | ( | int | i | ) |
Removes a package float data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedGridSettings.removePackageInt | ( | int | i | ) |
Removes a package integer data member.
| i | int Index of data member to remove. |
| void sortie.data.simpletypes.DetailedGridSettings.setXCellLength | ( | float | fValue | ) |
Sets the X cell length.
| fValue | X cell length, in m. |
| void sortie.data.simpletypes.DetailedGridSettings.setYCellLength | ( | float | fValue | ) |
Sets the Y cell length.
| fValue | Y cell length, in m. |
|
private |
Length of grid cells in X direction, in m.
|
private |
Grid name.
|
protected |
Vector of DataMembers representing package floats.
1.8.2