lerfob.treelogger.diameterbasedtreelogger

Class DiameterBasedTreeLogger

java.lang.Object

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

lerfob.treelogger.diameterbasedtreelogger.DiameterBasedTreeLogger

All Implemented Interfaces:

java.lang.Runnable, Executable, GenericTask

Direct Known Subclasses:

CATDiameterBasedTreeLogger, EuropeanBeechBasicTreeLogger, MaritimePineBasicTreeLogger

public class DiameterBasedTreeLogger
extends TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	shouldBreakAfterGettingPieces

Fields inherited from class repicea.simulation.treelogger.TreeLogger

listeners, loggerTask, owner, params, progressBarEnabled, wrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiameterBasedTreeLogger()
protected	DiameterBasedTreeLogger(boolean shouldBreakAfterGettingPieces) Constructor for derived class.

Method Summary

Modifier and Type	Method and Description
DiameterBasedTreeLoggerParameters	createDefaultTreeLoggerParameters() This method returns a set of default parameters to make sure the logger can work.
LoggableTree	getEligible(LoggableTree t) This method determines whether or not the tree is eligible for this tree logger.
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.
void	setTreeLoggerParameters() This method is called in GUI mode.

Methods inherited from class repicea.simulation.treelogger.TreeLogger

addTreeLoggerListener, addWoodPiece, cancel, getEligibleTreesFromACollection, getFailureReason, getLoggableTrees, getName, getTreeLoggerParameters, 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

Field Detail

shouldBreakAfterGettingPieces

protected final boolean shouldBreakAfterGettingPieces

Constructor Detail

DiameterBasedTreeLogger

protected DiameterBasedTreeLogger()

DiameterBasedTreeLogger

protected DiameterBasedTreeLogger(boolean shouldBreakAfterGettingPieces)

Constructor for derived class.

Parameters:

shouldBreakAfterGettingPieces - true should be preferred to false which is a former implementation

Method Detail

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.

Specified by:

logThisTree in class TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

setTreeLoggerParameters

public void setTreeLoggerParameters()

Description copied from class: TreeLogger

This method is called in GUI mode.

Specified by:

setTreeLoggerParameters in class TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

createDefaultTreeLoggerParameters

public DiameterBasedTreeLoggerParameters createDefaultTreeLoggerParameters()

Description copied from class: TreeLogger

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

Specified by:

createDefaultTreeLoggerParameters in class TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

Returns:

a set of Parameters-derived instance

getEligible

public LoggableTree 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.

Specified by:

getEligible in class TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

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

Specified by:

isCompatibleWith in class TreeLogger<DiameterBasedTreeLoggerParameters,LoggableTree>

Parameters:

check - a TreeLoggerCompatibilityCheck instance

Returns:

a boolean