javawrapper.ModelVector Class Reference

This class packages vector data with other pieces of information important to the model. More...

Inheritance diagram for javawrapper.ModelVector:

javawrapper.ModelData

List of all members.

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< Object > 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.

Private Attributes

Vector< Object > p_oData
 The data values.
String m_sXMLChildTag
 This is the XML tag of the individual values.
int m_iDataType
 Data type desired by this ModelVector.
boolean m_bIsForSpecies = true
 Whether this is a set of species-specific values - not all vectors are.
boolean m_bMustApplyToAllSpecies = false
 Whether or not this automatically applies to all species.


Detailed Description

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: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

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)

Constructor & Destructor Documentation

javawrapper.ModelVector.ModelVector ( String  sDescriptor,
String  sXMLTag,
String  sXMLChildTag,
int  iSize,
int  iDesiredDataType 
) [package]

Constructor.

Parameters:
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 
) [package]

Constructor.

Parameters:
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.


Member Function Documentation

String javawrapper.ModelVector.toString (  )  [virtual]

Required overridden method.

Returns:
null - this cannot be applied.

Implements javawrapper.ModelData.

String javawrapper.ModelVector.GetChildXMLTag (  ) 

Gets the XML tag used to identify each piece of data in the vector.

Returns:
The XML tag for this vector's data.

boolean javawrapper.ModelVector.GetMustApplyToAllSpecies (  ) 

Gets whether this vector must apply to all tree species, regardless of other factors controlling species.

Returns:
boolean Whether this vector must apply to all species.

boolean javawrapper.ModelVector.GetIsSpeciesSpecific (  ) 

Gets whether this vector is for species-specific values.

Returns:
boolean Whether this vector is for species-specific values.

void javawrapper.ModelVector.SetIsSpeciesSpecific ( boolean  bIsSpeciesSpecific  ) 

Sets whether this vector is for species-specific values.

Parameters:
bIsSpeciesSpecific boolean Whether this vector is for species- specific values.

Vector<Object> javawrapper.ModelVector.GetValue (  ) 

Gets the Vector values.

Returns:
The Vector values.

int javawrapper.ModelVector.GetDataType (  ) 

Gets the data type desired for this ModelVector.

Returns:
The desired data type.


Member Data Documentation

Vector<Object> javawrapper.ModelVector.p_oData [private]

The data values.

This is the XML tag of the individual values.

Data type desired by this ModelVector.

boolean javawrapper.ModelVector.m_bIsForSpecies = true [private]

Whether this is a set of species-specific values - not all vectors are.

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.

final int javawrapper.ModelVector.INTEGER = 0 [static]

This vector desires data of type Integer.

final int javawrapper.ModelVector.FLOAT = 1 [static]

This vector desires data of type Float.

final int javawrapper.ModelVector.MODEL_ENUM = 2 [static]

This vector desires data of type ModelEnum.

final int javawrapper.ModelVector.STRING = 3 [static]

This vector desires data of type String.


The documentation for this class was generated from the following file:

Generated on Wed Oct 28 14:01:22 2009 for SORTIE Java Interface by  doxygen 1.5.6