lerfob.carbonbalancetool.catdiameterbasedtreelogger

Class CATDiameterBasedTreeLogger

java.lang.Object

repicea.simulation.treelogger.TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

lerfob.treelogger.diameterbasedtreelogger.DiameterBasedTreeLogger

lerfob.carbonbalancetool.catdiameterbasedtreelogger.CATDiameterBasedTreeLogger

All Implemented Interfaces:

java.lang.Runnable, Executable, GenericTask

public class CATDiameterBasedTreeLogger
extends DiameterBasedTreeLogger

The CATDiameterBasedTreeLogger class implements a tree logger for CAT. It is based on a default species. However, the user can add different specification for some species.

Field Summary

Fields inherited from class lerfob.treelogger.diameterbasedtreelogger.DiameterBasedTreeLogger

shouldBreakAfterGettingPieces

Fields inherited from class repicea.simulation.treelogger.TreeLogger

listeners, loggerTask, owner, params, progressBarEnabled, wrapper

Constructor Summary

Constructors

Constructor and Description
CATDiameterBasedTreeLogger()

Method Summary

Modifier and Type	Method and Description
CATDiameterBasedTreeLoggerParameters	createDefaultTreeLoggerParameters() This method returns a set of default parameters to make sure the logger can work.
CATCompatibleTree	getEligible(LoggableTree t) This method determines whether or not the tree is eligible for this tree logger.
CATDiameterBasedTreeLoggerParameters	getTreeLoggerParameters() This method returns the parameters of the TreeLogger object.
boolean	isCompatibleWith(TreeLoggerCompatibilityCheck check) This method makes it possible to determine whether or not this TreeLogger class is compatible with the reference object
protected void	logThisTree(LoggableTree tree) This method process the trees into logs.

Methods inherited from class lerfob.treelogger.diameterbasedtreelogger.DiameterBasedTreeLogger

setTreeLoggerParameters

Methods inherited from class repicea.simulation.treelogger.TreeLogger

addTreeLoggerListener, addWoodPiece, cancel, getEligibleTreesFromACollection, getFailureReason, getLoggableTrees, getName, getWoodPieces, hasBeenCancelled, init, isCorrectlyTerminated, isSaveMemoryEnabled, isVerbose, logTrees, posteriorToRunning, priorToRunning, removeTreeLoggerListener, run, setProgressBarEnabled, setSaveMemoryEnabled, setTreeLoggerParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

CATDiameterBasedTreeLogger

public CATDiameterBasedTreeLogger()

Method Detail

createDefaultTreeLoggerParameters

public CATDiameterBasedTreeLoggerParameters createDefaultTreeLoggerParameters()

Description copied from class: TreeLogger

This method returns a set of default parameters to make sure the logger can work.

Overrides:

createDefaultTreeLoggerParameters in class DiameterBasedTreeLogger

Returns:

a set of Parameters-derived instance

getEligible

public CATCompatibleTree getEligible(LoggableTree t)

Description copied from class: TreeLogger

This method determines whether or not the tree is eligible for this tree logger. Typically, some criteria based on dbh or height can be specified here.

Overrides:

getEligible in class DiameterBasedTreeLogger

Parameters:

t - a LoggableTree instance

Returns:

the appropriate Tree instance if eligible or null otherwise

isCompatibleWith

public boolean isCompatibleWith(TreeLoggerCompatibilityCheck check)

Description copied from class: TreeLogger

This method makes it possible to determine whether or not this TreeLogger class is compatible with the reference object

Overrides:

isCompatibleWith in class DiameterBasedTreeLogger

Parameters:

check - a TreeLoggerCompatibilityCheck instance

Returns:

a boolean

getTreeLoggerParameters

public CATDiameterBasedTreeLoggerParameters getTreeLoggerParameters()

Description copied from class: TreeLogger

This method returns the parameters of the TreeLogger object.

Overrides:

getTreeLoggerParameters in class TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

Returns:

a Parameter-defined instance (see header of this class)

logThisTree

protected void logThisTree(LoggableTree tree)

Description copied from class: TreeLogger

This method process the trees into logs. It has to be defined in the derived class.

Overrides:

logThisTree in class DiameterBasedTreeLogger