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

Inheritance diagram for sortie.data.simpletypes.DataMemberData:

Public Member Functions
	DataMemberData (int iNumFloats, int iNumInts, int iNumChars, int iNumBools) throws ModelException
	Constructor. More...

int	getNumberOfFloats ()

int	getNumberOfInts ()

int	getNumberOfBools ()

int	getNumberOfChars ()

void	setValue (int iIndex, Integer iValue) throws ModelException
	Sets an integer data member's value. More...

void	setValue (int iIndex, Float fValue) throws ModelException
	Sets a float data member's value. More...

void	setValue (int iIndex, Boolean bValue) throws ModelException
	Sets a boolean data member's value. More...

void	setValue (int iIndex, String sValue) throws ModelException
	Sets a char data member's value. More...

Float	getFloat (int iIndex) throws ModelException
	Gets a float data member's value. More...

Integer	getInt (int iIndex) throws ModelException
	Gets an int data member's value. More...

Boolean	getBool (int iIndex) throws ModelException
	Gets a boolean data member's value. More...

String	getChar (int iIndex) throws ModelException
	Gets a char data member's value. More...

void	removeFloat (int iIndex) throws ModelException
	Removes a float data member's value. More...

void	removeInt (int iIndex) throws ModelException
	Removes an int data member's value. More...

void	removeBool (int iIndex) throws ModelException
	Removes a bool data member's value. More...

void	removeChar (int iIndex) throws ModelException
	Removes a char data member's value. More...

Protected Attributes
Float []	mp_fFloats
	Float data members. More...

Integer []	mp_iInts
	Int data members. More...

Boolean []	mp_bBools
	Bool data members. More...

String []	mp_sChars
	Char data members - these may get truncated when read into C++. More...

Detailed Description

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

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary 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

◆ DataMemberData()

sortie.data.simpletypes.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

◆ getBool()

Boolean sortie.data.simpletypes.DataMemberData.getBool ( int iIndex ) throws ModelException

Gets a boolean data member's value.

Parameters

iIndex Index at which to set the value.

Returns: The value to get.

Exceptions

ModelException if the index is invalid.

◆ getChar()

String sortie.data.simpletypes.DataMemberData.getChar ( int iIndex ) throws ModelException

Gets a char data member's value.

Parameters

iIndex Index at which to set the value.

Returns: The value to get.

Exceptions

ModelException if the index is invalid.

◆ getFloat()

Float sortie.data.simpletypes.DataMemberData.getFloat ( int iIndex ) throws ModelException

Gets a float data member's value.

Parameters

iIndex Index at which to set the value.

Returns: The value to get.

Exceptions

ModelException if the index is invalid.

◆ getInt()

Integer sortie.data.simpletypes.DataMemberData.getInt ( int iIndex ) throws ModelException

Gets an int data member's value.

Parameters

iIndex Index at which to set the value.

Returns: The value to get.

Exceptions

ModelException if the index is invalid.

◆ getNumberOfBools()

int sortie.data.simpletypes.DataMemberData.getNumberOfBools ( )

◆ getNumberOfChars()

int sortie.data.simpletypes.DataMemberData.getNumberOfChars ( )

◆ getNumberOfFloats()

int sortie.data.simpletypes.DataMemberData.getNumberOfFloats ( )

◆ getNumberOfInts()

int sortie.data.simpletypes.DataMemberData.getNumberOfInts ( )

◆ removeBool()

void sortie.data.simpletypes.DataMemberData.removeBool ( int iIndex ) throws ModelException

Removes a bool data member's value.

Parameters

iIndex Index at which to set the value.

Exceptions

ModelException if the index is invalid.

◆ removeChar()

void sortie.data.simpletypes.DataMemberData.removeChar ( int iIndex ) throws ModelException

Removes a char data member's value.

Parameters

iIndex Index at which to set the value.

Exceptions

ModelException if the index is invalid.

◆ removeFloat()

void sortie.data.simpletypes.DataMemberData.removeFloat ( int iIndex ) throws ModelException

Removes a float data member's value.

Parameters

iIndex Index at which to set the value.

Exceptions

ModelException if the index is invalid.

◆ removeInt()

void sortie.data.simpletypes.DataMemberData.removeInt ( int iIndex ) throws ModelException

Removes an int data member's value.

Parameters

iIndex Index at which to set the value.

Exceptions

ModelException if the index is invalid.

◆ setValue() [1/4]

void sortie.data.simpletypes.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.

◆ setValue() [2/4]

void sortie.data.simpletypes.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.

◆ setValue() [3/4]

void sortie.data.simpletypes.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.

◆ setValue() [4/4]

void sortie.data.simpletypes.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

◆ mp_bBools

Boolean [] sortie.data.simpletypes.DataMemberData.mp_bBools

protected

Bool data members.

◆ mp_fFloats

Float [] sortie.data.simpletypes.DataMemberData.mp_fFloats

protected

Float data members.

◆ mp_iInts

Integer [] sortie.data.simpletypes.DataMemberData.mp_iInts

protected

Int data members.

◆ mp_sChars

String [] sortie.data.simpletypes.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:

DataMemberData.java

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DataMemberData()

Member Function Documentation

◆ getBool()

◆ getChar()

◆ getFloat()

◆ getInt()

◆ getNumberOfBools()

◆ getNumberOfChars()

◆ getNumberOfFloats()

◆ getNumberOfInts()

◆ removeBool()

◆ removeChar()

◆ removeFloat()

◆ removeInt()

◆ setValue() [1/4]

◆ setValue() [2/4]

◆ setValue() [3/4]

◆ setValue() [4/4]

Member Data Documentation

◆ mp_bBools

◆ mp_fFloats

◆ mp_iInts

◆ mp_sChars