Public Member Functions | |
| DataMember (String sDisplayName, String sCodeName, int iType) throws ModelException | |
| Constructor. | |
| String | toString () |
| Overridden from Object. | |
| boolean | equals (Object oObject) |
| Tests for equality. | |
| String | GetDisplayName () |
| Constructor. | |
| void | SetDisplayName (String sNewName) |
| Sets the display name of this data member. | |
| String | GetCodeName () |
| Gets the code name of this data member. | |
| void | SetCodeName (String sNewName) |
| Sets the code name of this data member. | |
| int | GetType () |
| Gets the type of this data member. | |
| void | SetType (int iType) |
| Sets the type of this data member. | |
| int | GetCode () |
| Get the data member numerical code. | |
| void | SetCode (int iCode) |
| Sets the data member numerical code. | |
| Object | clone () |
| Creates a deep clone of this object. | |
Static Public Attributes | |
| static final int | INTEGER = 0 |
| Data member is of type integer. | |
| static final int | FLOAT = 1 |
| Data member is of type float. | |
| static final int | CHAR = 2 |
| Data member is of type char. | |
| static final int | BOOLEAN = 3 |
| Data member is of type boolean. | |
Protected Attributes | |
| String | m_sDisplayName |
| The display name is that which will be shown to users. | |
| String | m_sCodeName |
| The code name is that which will be written to detailed output - what the C++ code will recognize. | |
| int | m_iType |
| Data member type - one of the four static finals above. | |
| int | m_iCode |
| Data member code in detailed output files. | |
Not all class members need to be set - just whatever is needed by whoever is using this class.
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
| javawrapper.DataMember.DataMember | ( | String | sDisplayName, | |
| String | sCodeName, | |||
| int | iType | |||
| ) | throws ModelException |
Constructor.
| sDisplayName | The name which will be displayed to the user | |
| sCodeName | The name of the data member to be passed to the core model code. | |
| iType | The data member type - options are INTEGER, FLOAT, CHAR, and BOOLEAN |
| ModelException | If iType is not recognized. |
| String javawrapper.DataMember.toString | ( | ) |
Overridden from Object.
| boolean javawrapper.DataMember.equals | ( | Object | oObject | ) |
Tests for equality.
| oObject | Object to test |
| String javawrapper.DataMember.GetDisplayName | ( | ) |
Constructor.
| sLabel | The string to be used for both code name and display name. Gets the display name of this data member. |
| void javawrapper.DataMember.SetDisplayName | ( | String | sNewName | ) |
Sets the display name of this data member.
| sNewName | String New name to set. |
| String javawrapper.DataMember.GetCodeName | ( | ) |
Gets the code name of this data member.
| void javawrapper.DataMember.SetCodeName | ( | String | sNewName | ) |
Sets the code name of this data member.
| sNewName | String New name to set. |
| int javawrapper.DataMember.GetType | ( | ) |
Gets the type of this data member.
| void javawrapper.DataMember.SetType | ( | int | iType | ) |
Sets the type of this data member.
| Data | member type. |
| int javawrapper.DataMember.GetCode | ( | ) |
Get the data member numerical code.
| void javawrapper.DataMember.SetCode | ( | int | iCode | ) |
Sets the data member numerical code.
| iCode | The code number. |
| Object javawrapper.DataMember.clone | ( | ) |
Creates a deep clone of this object.
final int javawrapper.DataMember.INTEGER = 0 [static] |
Data member is of type integer.
final int javawrapper.DataMember.FLOAT = 1 [static] |
Data member is of type float.
final int javawrapper.DataMember.CHAR = 2 [static] |
Data member is of type char.
final int javawrapper.DataMember.BOOLEAN = 3 [static] |
Data member is of type boolean.
String javawrapper.DataMember.m_sDisplayName [protected] |
The display name is that which will be shown to users.
String javawrapper.DataMember.m_sCodeName [protected] |
The code name is that which will be written to detailed output - what the C++ code will recognize.
int javawrapper.DataMember.m_iType [protected] |
Data member type - one of the four static finals above.
int javawrapper.DataMember.m_iCode [protected] |
Data member code in detailed output files.
1.5.6