javawrapper::SpeciesTypeCombo Class Reference

This class allows you to group together a species number and a type number into one object that can be placed in an array or vector or passed as an argument. More...

List of all members.

Public Member Functions

 SpeciesTypeCombo (int iSpecies, int iType, TreePopulation oPop) throws ModelException
 Constructor.
void SetSpecies (int iSpecies)
 Species setter.
boolean equals (Object oToCheck)
 Implemented equality checker.
Object clone ()
 Override this so clones can be made.
int GetSpecies ()
 Gets the species for this combo.
int GetType ()
 Gets the type for this combo.


Detailed Description

This class allows you to group together a species number and a type number into one object that can be placed in an array or vector or passed as an argument.

This is useful, for instance, when a behavior object wants to keep a list of those species and types to which each of its sub-behaviors applies.

Copyright: Copyright (c) 2003

Company:

Author:
not attributable
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
January 23, 2007: Removed problematic error processing (LEM)


Constructor & Destructor Documentation

javawrapper::SpeciesTypeCombo::SpeciesTypeCombo ( int  iSpecies,
int  iType,
TreePopulation  oPop 
) throws ModelException [inline]

Constructor.

Parameters:
iSpecies Species number.
iType Type number.
oPop Tree population object for data validation.
Exceptions:
ModelException if either species or type number is invalid

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


Member Function Documentation

void javawrapper::SpeciesTypeCombo::SetSpecies ( int  iSpecies  )  [inline]

Species setter.

Parameters:
iSpecies Species to set.

boolean javawrapper::SpeciesTypeCombo::equals ( Object  oToCheck  )  [inline]

Implemented equality checker.

Parameters:
oToCheck Object to check for equality.
Returns:
true if species and type both match, false otherwise.

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

Object javawrapper::SpeciesTypeCombo::clone (  )  [inline]

Override this so clones can be made.

Returns:
Clone of this object.

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

int javawrapper::SpeciesTypeCombo::GetSpecies (  )  [inline]

Gets the species for this combo.

Returns:
The species.

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

int javawrapper::SpeciesTypeCombo::GetType (  )  [inline]

Gets the type for this combo.

Returns:
The type.

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


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:55 2007 for SORTIE Java Interface by  doxygen 1.5.2