lerfob.treelogger.basictreelogger

Class BasicLogCategory

java.lang.Object

repicea.simulation.treelogger.LogCategory

lerfob.treelogger.basictreelogger.BasicLogCategory

All Implemented Interfaces:

java.io.Serializable, REpiceaUIObject

public class BasicLogCategory
extends LogCategory

The BasicLogCategory class is the basic implementation of the TreeLogCategory abstract class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicLogCategory(java.lang.String name, java.lang.String species, double volumeProportionToBeProcessedInThisCategory) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<BasicTreeLoggerWoodPiece>	extractFromTree(LoggableTree tree, java.lang.Object... parms) This method returns a wood piece if it can be extract from the tree.
lerfob.treelogger.basictreelogger.BasicLogCategory.CarbonAccountingToolDefaultLogCategoryPanel	getUI() This method returns the GUI interface of the class that implements this interface.
protected double	getVolumeProportion()
double	getYieldFromThisPiece(WoodPiece piece) This method returns the yield of this piece, i.e.
boolean	isVisible() This method returns true if the GUI is visible.
protected void	setVolumeProportion(double d)

Methods inherited from class repicea.simulation.treelogger.LogCategory

equals, getName, getSpecies, isFromStump, setName, setSpecies, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicLogCategory

public BasicLogCategory(java.lang.String name,
                        java.lang.String species,
                        double volumeProportionToBeProcessedInThisCategory)

Constructor.

Parameters:

name - the name of the category

species - the species name

volumeProportionToBeProcessedInThisCategory - the proportion of the merchantable volume that falls into this category

Method Detail

getUI

public lerfob.treelogger.basictreelogger.BasicLogCategory.CarbonAccountingToolDefaultLogCategoryPanel getUI()

Description copied from interface: REpiceaUIObject

This method returns the GUI interface of the class that implements this interface.

Returns:

a Component instance

getYieldFromThisPiece

public double getYieldFromThisPiece(WoodPiece piece)
                             throws java.lang.Exception

Description copied from class: LogCategory

This method returns the yield of this piece, i.e. the volume of end use products with respect to the initial volume of this piece.

Specified by:

getYieldFromThisPiece in class LogCategory

Parameters:

piece - a WoodPiece instance

Returns:

a Double

Throws:

java.lang.Exception

setVolumeProportion

protected void setVolumeProportion(double d)

getVolumeProportion

protected double getVolumeProportion()

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObject

This method returns true if the GUI is visible.

Returns:

a boolean

extractFromTree

protected java.util.List<BasicTreeLoggerWoodPiece> extractFromTree(LoggableTree tree,
                                                                   java.lang.Object... parms)

Description copied from class: LogCategory

This method returns a wood piece if it can be extract from the tree.

Specified by:

extractFromTree in class LogCategory

Parameters:

tree - a LoggableTree instance

parms - optional parameters

Returns:

a WoodPiece instance or null if cannot be extracted from the tree