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, TreePopulation oPop) throws ModelException
 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.

Private Member Functions

 SpeciesTypeCombo (int iSpecies, int iType)
 Constructor.

Private Attributes

int m_iSpecies
 Tree species.
int m_iType
 Tree type.


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)


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)

javawrapper::SpeciesTypeCombo::SpeciesTypeCombo int  iSpecies,
int  iType
[inline, private]
 

Constructor.

Private so that the cloning process can use it without having to go through validation with the TreePopulation - since presumably an already existing object would have validated in its own constructor.

Parameters:
iSpecies Tree species.
iType Tree type.

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


Member Function Documentation

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)

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)

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)

void javawrapper::SpeciesTypeCombo::SetSpecies int  iSpecies,
TreePopulation  oPop
throws ModelException [inline]
 

Species setter.

Parameters:
iSpecies Species to set.
oPop TreePopulation object.
Exceptions:
ModelException if the species is invalid.

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:47 2006 for SORTIE Java Interface by  doxygen 1.4.6-NO