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

Public Member Functions
	SpeciesTypeCombo (int iSpecies, int iType, TreePopulation oPop) throws ModelException
	Constructor. More...
void	setSpecies (int iSpecies) throws ModelException
	Species setter. More...
boolean	equals (Object oToCheck)
	Implemented equality checker. More...
Object	clone ()
	Override this so clones can be made. More...
int	getSpecies ()
	Gets the species for this combo. More...
int	getType ()
	Gets the type for this combo. More...

Private Member Functions
	SpeciesTypeCombo (int iSpecies, int iType)
	Constructor. More...

Private Attributes
int	m_iSpecies
	Tree species. More...

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

SpeciesTypeCombo() [1/2]

sortie.data.simpletypes.SpeciesTypeCombo.SpeciesTypeCombo	(	int	iSpecies,
		int	iType,
		TreePopulation	oPop
	)		throws ModelException

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

SpeciesTypeCombo() [2/2]

sortie.data.simpletypes.SpeciesTypeCombo.SpeciesTypeCombo ( int  iSpecies, int  iType  )

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.

Member Function Documentation

clone()

Object sortie.data.simpletypes.SpeciesTypeCombo.clone

(

)

Override this so clones can be made.

Returns

Clone of this object.

equals()

boolean sortie.data.simpletypes.SpeciesTypeCombo.equals

(

Object

oToCheck

)

Implemented equality checker.

Parameters

oToCheck

Object to check for equality.

Returns

true if species and type both match, false otherwise.

getSpecies()

int sortie.data.simpletypes.SpeciesTypeCombo.getSpecies

(

)

Gets the species for this combo.

Returns

The species.

getType()

int sortie.data.simpletypes.SpeciesTypeCombo.getType

(

)

Gets the type for this combo.

Returns

The type.

setSpecies()

void sortie.data.simpletypes.SpeciesTypeCombo.setSpecies

(

int

iSpecies

)

throws ModelException

Species setter.

Parameters

iSpecies

Species to set.

Member Data Documentation

m_iSpecies

int sortie.data.simpletypes.SpeciesTypeCombo.m_iSpecies

private

Tree species.

---

The documentation for this class was generated from the following file:

• SpeciesTypeCombo.java