lerfob.treelogger.diameterbasedtreelogger

Class DiameterBasedTreeLogCategory

java.lang.Object

repicea.simulation.treelogger.LogCategory

lerfob.treelogger.diameterbasedtreelogger.DiameterBasedTreeLogCategory

All Implemented Interfaces:

java.io.Serializable, REpiceaUIObject

Direct Known Subclasses:

CATDiameterBasedTreeLogCategory, EuropeanBeechBasicTreeLogCategory, MaritimePineBasicTreeLogCategory

public class DiameterBasedTreeLogCategory
extends LogCategory

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double	conversionFactor
protected double	downgradingProportion
protected boolean	isChangeAllowed
protected boolean	isConversionEnabled
protected boolean	isDowngradingEnabled
protected java.lang.Enum<?>	logGrade
protected double	minimumDbhCm
protected DiameterBasedTreeLogCategory	subCategory

Constructor Summary

Constructors

Constructor and Description
DiameterBasedTreeLogCategory(java.lang.Enum<?> logGrade, java.lang.Object species, double minimumDbhCm, boolean isFromStump, DiameterBasedTreeLogCategory subCategory) A default constructor with 100% conversion factor and no downgrading.
DiameterBasedTreeLogCategory(java.lang.Enum<?> logGrade, java.lang.Object species, double minimumDbhCm, DiameterBasedTreeLogCategory subCategory) A default constructor with 100% conversion factor, no downgrading and not from stump.
DiameterBasedTreeLogCategory(java.lang.Enum<?> logGrade, java.lang.Object species, double minimumDbhCm, double conversionFactor, double downgradingFactor, boolean isFromStump, DiameterBasedTreeLogCategory subCategory) General contructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
protected java.util.List<DiameterBasedWoodPiece>	extractFromTree(LoggableTree tree, java.lang.Object... parms) This method returns a wood piece if it can be extract from the tree.
java.lang.Enum<?>	getGrade()
DiameterBasedTreeLogCategoryPanel	getUI() This method returns the GUI interface of the class that implements this interface.
double	getYieldFromThisPiece(WoodPiece piece) This method returns the yield of this piece, i.e.
protected boolean	isEligible(LoggableTree tree)
boolean	isVisible() This method returns true if the GUI is visible.

Methods inherited from class repicea.simulation.treelogger.LogCategory

getName, getSpecies, isFromStump, setName, setSpecies, toString

Methods inherited from class java.lang.Object

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

Field Detail

isChangeAllowed

protected boolean isChangeAllowed

minimumDbhCm

protected double minimumDbhCm

conversionFactor

protected double conversionFactor

downgradingProportion

protected double downgradingProportion

isConversionEnabled

protected final boolean isConversionEnabled

isDowngradingEnabled

protected final boolean isDowngradingEnabled

subCategory

protected DiameterBasedTreeLogCategory subCategory

logGrade

protected final java.lang.Enum<?> logGrade

Constructor Detail

DiameterBasedTreeLogCategory

public DiameterBasedTreeLogCategory(java.lang.Enum<?> logGrade,
                                    java.lang.Object species,
                                    double minimumDbhCm,
                                    double conversionFactor,
                                    double downgradingFactor,
                                    boolean isFromStump,
                                    DiameterBasedTreeLogCategory subCategory)

General contructor.

Parameters:

logGrade - an Enum that represents the log category

species - a species name

minimumDbhCm - a minimum diameter for this log grade either null or positive

conversionFactor - a conversion factor either null or within the interval [0,1]

downgradingFactor - a downgrading factor either null or within the interval [0,1]

isFromStump - a boolean

subCategory - a DiameterBasedTreeLogCategory for by products

DiameterBasedTreeLogCategory

public DiameterBasedTreeLogCategory(java.lang.Enum<?> logGrade,
                                    java.lang.Object species,
                                    double minimumDbhCm,
                                    boolean isFromStump,
                                    DiameterBasedTreeLogCategory subCategory)

A default constructor with 100% conversion factor and no downgrading.

Parameters:

logGrade - an Enum that represents the log category

species - a species name

minimumDbhCm - a minimum diameter for this log grade either null or positive

isFromStump - a boolean

subCategory - a DiameterBasedTreeLogCategory for by products

DiameterBasedTreeLogCategory

public DiameterBasedTreeLogCategory(java.lang.Enum<?> logGrade,
                                    java.lang.Object species,
                                    double minimumDbhCm,
                                    DiameterBasedTreeLogCategory subCategory)

A default constructor with 100% conversion factor, no downgrading and not from stump.

Parameters:

logGrade - an Enum that represents the log category

species - a species name

minimumDbhCm - a minimum diameter for this log grade either null or positive

subCategory - a DiameterBasedTreeLogCategory for by products

Method Detail

getUI

public DiameterBasedTreeLogCategoryPanel 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

getGrade

public java.lang.Enum<?> getGrade()

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObject

This method returns true if the GUI is visible.

Returns:

a boolean

isEligible

protected boolean isEligible(LoggableTree tree)

extractFromTree

protected java.util.List<DiameterBasedWoodPiece> 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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class LogCategory