javawrapper.DataMemberData Class Reference

Abstract class holding data member-based data, such as trees or grid values. More...

Inheritance diagram for javawrapper.DataMemberData:

javawrapper.GridValue javawrapper.PackageGridValue javawrapper.Tree

List of all members.

Public Member Functions

 DataMemberData (int iNumFloats, int iNumInts, int iNumChars, int iNumBools) throws ModelException
 Constructor.
void SetValue (int iIndex, Integer iValue) throws ModelException
 Sets an integer data member's value.
void SetValue (int iIndex, Float fValue) throws ModelException
 Sets a float data member's value.
void SetValue (int iIndex, Boolean bValue) throws ModelException
 Sets a boolean data member's value.
void SetValue (int iIndex, String sValue) throws ModelException
 Sets a char data member's value.

Protected Attributes

Float[] mp_fFloats
 Float data members.
Integer[] mp_iInts
 Int data members.
Boolean[] mp_bBools
 Bool data members.
String[] mp_sChars
 Char data members - these may get truncated when read into C++.


Detailed Description

Abstract class holding data member-based data, such as trees or grid values.

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 29, 2010: Changed Floats to Floats

Constructor & Destructor Documentation

javawrapper.DataMemberData.DataMemberData ( int  iNumFloats,
int  iNumInts,
int  iNumChars,
int  iNumBools 
) throws ModelException

Constructor.

Creates the arrays.

Parameters:
iNumFloats Number of float data members
iNumInts Number of integer data members
iNumChars Number of char (String) data members
iNumBools Number of bool data members
Exceptions:
ModelException if the species or type numbers are invalid


Member Function Documentation

void javawrapper.DataMemberData.SetValue ( int  iIndex,
Integer  iValue 
) throws ModelException

Sets an integer data member's value.

Parameters:
iIndex Index at which to set the value.
iValue The value to set.
Exceptions:
ModelException if the index is invalid.

void javawrapper.DataMemberData.SetValue ( int  iIndex,
Float  fValue 
) throws ModelException

Sets a float data member's value.

Parameters:
iIndex Index at which to set the value.
fValue The value to set.
Exceptions:
ModelException if the index is invalid.

void javawrapper.DataMemberData.SetValue ( int  iIndex,
Boolean  bValue 
) throws ModelException

Sets a boolean data member's value.

Parameters:
iIndex Index at which to set the value.
bValue The value to set.
Exceptions:
ModelException if the index is invalid.

void javawrapper.DataMemberData.SetValue ( int  iIndex,
String  sValue 
) throws ModelException

Sets a char data member's value.

Parameters:
iIndex Index at which to set the value.
sValue The value to set.
Exceptions:
ModelException if the index is invalid.


Member Data Documentation

Float data members.

Integer [] javawrapper.DataMemberData.mp_iInts [protected]

Int data members.

Boolean [] javawrapper.DataMemberData.mp_bBools [protected]

Bool data members.

String [] javawrapper.DataMemberData.mp_sChars [protected]

Char data members - these may get truncated when read into C++.


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

Generated on Tue Apr 19 13:59:37 2011 for SORTIE Java Interface by  doxygen 1.5.6