javawrapper.DetailedTreeSettings Class Reference

This class packages together a set of tree settings. More...

Inheritance diagram for javawrapper.DetailedTreeSettings:

javawrapper.DetailedOutputSettings

List of all members.

Public Member Functions

 DetailedTreeSettings (int iType, int iSpecies)
 Constructor.
 DetailedTreeSettings (int iType, int iSpecies, int iDeadCode)
 Constructor.
int GetSpecies ()
 Gets the tree species.
void SetSpecies (int iNewSpecies)
 Sets the tree species.
int GetDeadCode ()
 Gets the dead code.
int GetType ()
 Gets the tree type.
Object clone ()
 Creates a deep clone of this object.

Private Attributes

int m_iType
 Tree type.
int m_iSpecies
 Tree species.
int m_iDeadCode
 Dead reason code - can be not dead.


Detailed Description

This class packages together a set of tree settings.

For a given species and tree type, this will tell you what is available in a tree map (or detailed output file).

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)
February 1, 2011: Added support for dead trees (LEM)

Constructor & Destructor Documentation

javawrapper.DetailedTreeSettings.DetailedTreeSettings ( int  iType,
int  iSpecies 
)

Constructor.

Parameters:
iType Tree type.
iSpecies Tree species.

javawrapper.DetailedTreeSettings.DetailedTreeSettings ( int  iType,
int  iSpecies,
int  iDeadCode 
)

Constructor.

Parameters:
iType Tree type.
iSpecies Tree species.
iDeadCode Valid dead reason code from output behaviors.


Member Function Documentation

int javawrapper.DetailedTreeSettings.GetSpecies (  ) 

Gets the tree species.

Returns:
Tree species.

void javawrapper.DetailedTreeSettings.SetSpecies ( int  iNewSpecies  ) 

Sets the tree species.

Parameters:
iNewSpecies Tree species.

int javawrapper.DetailedTreeSettings.GetDeadCode (  ) 

Gets the dead code.

Returns:
The dead code.

int javawrapper.DetailedTreeSettings.GetType (  ) 

Gets the tree type.

Returns:
Tree type.

Object javawrapper.DetailedTreeSettings.clone (  ) 

Creates a deep clone of this object.

Returns:
Clone.


Member Data Documentation

Tree type.

Tree species.

Dead reason code - can be not dead.


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

Generated on Tue Apr 19 13:59:38 2011 for SORTIE Java Interface by  doxygen 1.5.6