Public Member Functions | |
ModelEnum (int[] p_iAllowedValues, String[] p_sValueLabels, String sDescriptor, String sXMLTag) | |
Constructor. | |
String | toString () |
Required overridden method. | |
void | SetValue (int iValue) throws ModelException |
Sets the value. | |
void | SetValue (String sValue) throws ModelException |
Sets the value using one of the string literals. | |
int | GetValue () |
Gets the integer value. | |
String | GetStringValue () |
Get the string label corresponding to the current integer value. | |
int[] | GetAllowedValues () |
Gets the set of all allowed values. | |
String[] | GetAllowedValueLabels () |
Gets the set of allowed value labels. | |
boolean | equals (Object oTest) |
Overriding equality tester. | |
Object | clone () |
Clones this object. | |
Protected Attributes | |
int | m_iValue |
Variable's value. | |
int[] | mp_iAllowedValues |
Set of allowed values. | |
String[] | mp_sValueLabels |
Label to display for each value. |
This object has a limited number of values it can accept.
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
javawrapper.ModelEnum.ModelEnum | ( | int[] | p_iAllowedValues, | |
String[] | p_sValueLabels, | |||
String | sDescriptor, | |||
String | sXMLTag | |||
) |
Constructor.
p_iAllowedValues | Allowed values. | |
p_sValueLabels | Text label for each allowed value. Optional. | |
sDescriptor | Descriptor string. | |
sXMLTag | The XML tag associated with this piece of data. |
String javawrapper.ModelEnum.toString | ( | ) | [virtual] |
Required overridden method.
Implements javawrapper.ModelData.
void javawrapper.ModelEnum.SetValue | ( | int | iValue | ) | throws ModelException |
Sets the value.
iValue | Value to set. |
ModelException | if the value is not an allowed value. |
void javawrapper.ModelEnum.SetValue | ( | String | sValue | ) | throws ModelException |
Sets the value using one of the string literals.
sValue | String value. |
ModelException | if the string literal does not correspond to an allowed value. |
int javawrapper.ModelEnum.GetValue | ( | ) |
Gets the integer value.
String javawrapper.ModelEnum.GetStringValue | ( | ) |
Get the string label corresponding to the current integer value.
int [] javawrapper.ModelEnum.GetAllowedValues | ( | ) |
Gets the set of all allowed values.
String [] javawrapper.ModelEnum.GetAllowedValueLabels | ( | ) |
Gets the set of allowed value labels.
boolean javawrapper.ModelEnum.equals | ( | Object | oTest | ) |
Overriding equality tester.
oTest | Object to test for equality |
Object javawrapper.ModelEnum.clone | ( | ) |
Clones this object.
int javawrapper.ModelEnum.m_iValue [protected] |
Variable's value.
int [] javawrapper.ModelEnum.mp_iAllowedValues [protected] |
Set of allowed values.
String [] javawrapper.ModelEnum.mp_sValueLabels [protected] |
Label to display for each value.