Inheritance diagram for javawrapper::ModelVector:
Public Member Functions | |
String | toString () |
Required overridden method. | |
String | GetChildXMLTag () |
Gets the XML tag used to identify each piece of data in the vector. | |
boolean | GetMustApplyToAllSpecies () |
Gets whether this vector must apply to all tree species, regardless of other factors controlling species. | |
boolean | GetIsSpeciesSpecific () |
Gets whether this vector is for species-specific values. | |
void | SetIsSpeciesSpecific (boolean bIsSpeciesSpecific) |
Sets whether this vector is for species-specific values. | |
Vector | GetValue () |
Gets the Vector values. | |
int | GetDataType () |
Gets the data type desired for this ModelVector. | |
Static Public Attributes | |
static final int | INTEGER = 0 |
This vector desires data of type Integer. | |
static final int | FLOAT = 1 |
This vector desires data of type Float. | |
static final int | MODEL_ENUM = 2 |
This vector desires data of type ModelEnum. | |
static final int | STRING = 3 |
This vector desires data of type String. | |
Package Functions | |
ModelVector (String sDescriptor, String sXMLTag, String sXMLChildTag, int iSize, int iDesiredDataType) | |
Constructor. | |
ModelVector (String sDescriptor, String sXMLTag, String sXMLChildTag, int iSize, int iDesiredDataType, boolean bMustApplyToAllSpecies) | |
Constructor. |
This allows a vector of data to self-describe to error messages and display windows, and to identify the data that belongs to it in XML files being read and written.
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
javawrapper::ModelVector::ModelVector | ( | String | sDescriptor, | |
String | sXMLTag, | |||
String | sXMLChildTag, | |||
int | iSize, | |||
int | iDesiredDataType | |||
) | [inline, package] |
Constructor.
sDescriptor | A descriptive name string for this value. This will appear in the data window and in error messages. | |
sXMLTag | The XML tag of the whole vector | |
sXMLChildTag | The XML tag of individual values within the vector | |
iSize | Initial size of the vector. 0 is always safe (since vectors grow to accommodate whatever data is placed in them). | |
iDesiredDataType | Desired data type of this vector. |
javawrapper::ModelVector::ModelVector | ( | String | sDescriptor, | |
String | sXMLTag, | |||
String | sXMLChildTag, | |||
int | iSize, | |||
int | iDesiredDataType, | |||
boolean | bMustApplyToAllSpecies | |||
) | [inline, package] |
Constructor.
sDescriptor | A descriptive name string for this value. This will appear in the data window and in error messages. | |
sXMLTag | The XML tag of the whole vector | |
sXMLChildTag | The XML tag of individual values within the vector | |
iSize | Initial size of the vector. 0 is always safe (since vectors grow to accommodate whatever data is placed in them). | |
iDesiredDataType | Desired data type of this vector. | |
bMustApplyToAllSpecies | Whether or not this vector automatically applies to all species, overriding any other method of determining which species it applies to. |
String javawrapper::ModelVector::toString | ( | ) | [inline, virtual] |
Required overridden method.
Implements javawrapper::ModelData.
String javawrapper::ModelVector::GetChildXMLTag | ( | ) | [inline] |
Gets the XML tag used to identify each piece of data in the vector.
boolean javawrapper::ModelVector::GetMustApplyToAllSpecies | ( | ) | [inline] |
Gets whether this vector must apply to all tree species, regardless of other factors controlling species.
boolean javawrapper::ModelVector::GetIsSpeciesSpecific | ( | ) | [inline] |
Gets whether this vector is for species-specific values.
void javawrapper::ModelVector::SetIsSpeciesSpecific | ( | boolean | bIsSpeciesSpecific | ) | [inline] |
Sets whether this vector is for species-specific values.
bIsSpeciesSpecific | boolean Whether this vector is for species- specific values. |
Vector javawrapper::ModelVector::GetValue | ( | ) | [inline] |
Gets the Vector values.
int javawrapper::ModelVector::GetDataType | ( | ) | [inline] |
Gets the data type desired for this ModelVector.