|
SORTIE Java Interface
1
|
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...
Public Member Functions | |
| SpeciesTypeCombo (int iSpecies, int iType, TreePopulation oPop) throws ModelException | |
| Constructor. | |
| void | setSpecies (int iSpecies) 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. | |
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:
Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)
January 23, 2007: Removed problematic error processing (LEM)
| sortie.data.simpletypes.SpeciesTypeCombo.SpeciesTypeCombo | ( | int | iSpecies, |
| int | iType, | ||
| TreePopulation | oPop | ||
| ) | throws ModelException |
Constructor.
| iSpecies | Species number. |
| iType | Type number. |
| oPop | Tree population object for data validation. |
| ModelException | if either species or type number is invalid |
|
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.
| iSpecies | Tree species. |
| iType | Tree type. |
| Object sortie.data.simpletypes.SpeciesTypeCombo.clone | ( | ) |
Override this so clones can be made.
| boolean sortie.data.simpletypes.SpeciesTypeCombo.equals | ( | Object | oToCheck | ) |
Implemented equality checker.
| oToCheck | Object to check for equality. |
| int sortie.data.simpletypes.SpeciesTypeCombo.getSpecies | ( | ) |
Gets the species for this combo.
| int sortie.data.simpletypes.SpeciesTypeCombo.getType | ( | ) |
Gets the type for this combo.
| void sortie.data.simpletypes.SpeciesTypeCombo.setSpecies | ( | int | iSpecies | ) | throws ModelException |
Species setter.
| iSpecies | Species to set. |
|
private |
Tree species.
1.8.2