SORTIE Java Interface
1
|
This class packages vector data with other pieces of information important to the model. More...
Public Member Functions | |
String | toString () |
Required overridden method. More... | |
ModelVector (String sDescriptor, String sXMLTag, String sXMLChildTag, int iSize, int iDesiredDataType) | |
Constructor. More... | |
ModelVector (String sDescriptor, String sXMLTag, String sXMLChildTag, int iSize, int iDesiredDataType, boolean bMustApplyToAllSpecies) | |
Constructor. More... | |
String | getChildXMLTag () |
Gets the XML tag used to identify each piece of data in the vector. More... | |
boolean | getMustApplyToAllSpecies () |
Gets whether this vector must apply to all tree species, regardless of other factors controlling species. More... | |
boolean | getIsSpeciesSpecific () |
Gets whether this vector is for species-specific values. More... | |
void | setIsSpeciesSpecific (boolean bIsSpeciesSpecific) |
Sets whether this vector is for species-specific values. More... | |
ArrayList< Object > | getValue () |
Gets the Vector values. More... | |
int | getDataType () |
Gets the data type desired for this ModelVector. More... | |
Public Member Functions inherited from sortie.data.simpletypes.ModelData | |
ModelData (String sDescriptor, String sXMLTag) | |
Constructor. More... | |
String | getDescriptor () |
Returns the descriptor string. More... | |
void | setDescriptor (String sDescriptor) |
Sets the descriptor string. More... | |
String | getXMLTag () |
Returns the XML tag associated with this piece of data. More... | |
abstract String | toString () |
String representation of the value. More... | |
void | setXMLTag (String sXMLTag) |
Sets the XML tag associated with this piece of data. More... | |
Static Public Attributes | |
static final int | INTEGER = 0 |
This vector desires data of type Integer. More... | |
static final int | FLOAT = 1 |
This vector desires data of type Float. More... | |
static final int | MODEL_ENUM = 2 |
This vector desires data of type ModelEnum. More... | |
static final int | STRING = 3 |
This vector desires data of type String. More... | |
static final int | DOUBLE = 4 |
This vector desires data of type Float. More... | |
Protected Member Functions | |
Object | clone () |
Clone method. More... | |
Private Attributes | |
ArrayList< Object > | mp_oData |
The data values. More... | |
String | m_sXMLChildTag |
This is the XML tag of the individual values. More... | |
int | m_iDataType |
Data type desired by this ModelVector. More... | |
boolean | m_bIsForSpecies = true |
Whether this is a set of species-specific values - not all vectors are. More... | |
boolean | m_bMustApplyToAllSpecies = false |
Whether or not this automatically applies to all species. More... | |
Additional Inherited Members | |
Protected Attributes inherited from sortie.data.simpletypes.ModelData | |
String | m_sDescriptor |
Descriptive string. More... | |
This class packages vector data with other pieces of information important to the model.
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: Cary Institute of Ecosystem Studies
Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)
October 7, 2004: Added the m_bMustApplyToAllSpecies member (LEM)
January 22, 2005: Added the m_bIsForSpecies member (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)
October 29, 2010: Add support for Float
May 31, 2013: Added cloning
sortie.data.simpletypes.ModelVector.ModelVector | ( | String | sDescriptor, |
String | sXMLTag, | ||
String | sXMLChildTag, | ||
int | iSize, | ||
int | iDesiredDataType | ||
) |
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. |
sortie.data.simpletypes.ModelVector.ModelVector | ( | String | sDescriptor, |
String | sXMLTag, | ||
String | sXMLChildTag, | ||
int | iSize, | ||
int | iDesiredDataType, | ||
boolean | bMustApplyToAllSpecies | ||
) |
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. |
|
protected |
Clone method.
String sortie.data.simpletypes.ModelVector.getChildXMLTag | ( | ) |
Gets the XML tag used to identify each piece of data in the vector.
int sortie.data.simpletypes.ModelVector.getDataType | ( | ) |
Gets the data type desired for this ModelVector.
boolean sortie.data.simpletypes.ModelVector.getIsSpeciesSpecific | ( | ) |
Gets whether this vector is for species-specific values.
boolean sortie.data.simpletypes.ModelVector.getMustApplyToAllSpecies | ( | ) |
Gets whether this vector must apply to all tree species, regardless of other factors controlling species.
ArrayList<Object> sortie.data.simpletypes.ModelVector.getValue | ( | ) |
Gets the Vector values.
void sortie.data.simpletypes.ModelVector.setIsSpeciesSpecific | ( | boolean | bIsSpeciesSpecific | ) |
Sets whether this vector is for species-specific values.
bIsSpeciesSpecific | boolean Whether this vector is for species- specific values. |
String sortie.data.simpletypes.ModelVector.toString | ( | ) |
Required overridden method.
|
static |
This vector desires data of type Float.
|
static |
This vector desires data of type Float.
|
static |
This vector desires data of type Integer.
|
private |
Whether this is a set of species-specific values - not all vectors are.
|
private |
Whether or not this automatically applies to all species.
If false, then which species values are contained in this vector is controlled by such factors as what behaviors claim it and what species they apply to.
|
private |
Data type desired by this ModelVector.
|
private |
This is the XML tag of the individual values.
|
static |
This vector desires data of type ModelEnum.
|
private |
The data values.
|
static |
This vector desires data of type String.