javawrapper::PlantingData::PlantingAbundance Class Reference

This encapsulates a species with its planting abundance. More...

List of all members.

Public Member Functions

 PlantingAbundance (int iSpecies, float fAbundance) throws ModelException
 Constructor.
float GetAbundance ()
 Gets the planting abundance.
int GetSpecies ()
 Gets the species number.
void SetAbundance (float fAbundance) throws ModelException
 Sets the abundance amount.

Private Attributes

float m_fAbundance
 Planting abundance.
int m_iSpecies
 Species for this abundance.


Detailed Description

This encapsulates a species with its planting abundance.

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)


Constructor & Destructor Documentation

javawrapper::PlantingData::PlantingAbundance::PlantingAbundance int  iSpecies,
float  fAbundance
throws ModelException [inline]
 

Constructor.

Parameters:
iSpecies The species index number.
fAbundance The abundance for this species - as a percentage (between 0 and 100)
Exceptions:
ModelException if the abundance is less than zero or is not a percentage

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Member Function Documentation

float javawrapper::PlantingData::PlantingAbundance::GetAbundance  )  [inline]
 

Gets the planting abundance.

Returns:
The planting abundance.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

int javawrapper::PlantingData::PlantingAbundance::GetSpecies  )  [inline]
 

Gets the species number.

Returns:
The species number.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::PlantingData::PlantingAbundance::SetAbundance float  fAbundance  )  throws ModelException [inline]
 

Sets the abundance amount.

Parameters:
fAbundance The abundance for this species - as a percentage (between 0 and 100)
Exceptions:
ModelException if the abundance is less than zero or is not a percentage

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 15:15:46 2006 for SORTIE Java Interface by  doxygen 1.4.6-NO