lerfob.carbonbalancetool

Class CarbonAccountingTool

java.lang.Object

repicea.app.AbstractGenericEngine

lerfob.carbonbalancetool.CarbonAccountingTool

All Implemented Interfaces:

REpiceaShowableUI, REpiceaShowableUIWithParent, REpiceaUIObject, REpiceaUIObjectWithParent

Direct Known Subclasses:

PythonAccessPoint

public class CarbonAccountingTool
extends AbstractGenericEngine
implements REpiceaShowableUIWithParent, REpiceaShowableUI

LERFoBCarbonAccountingTool is the class that implements a tool for the calculation of the carbon balance in a series of CarbonToolCompatibleStand instances (LERFoB-CAT).

ARCHITECTURE : The LERFoBCarbonAccountingTool has a GUI interface and it is in charge of calculating the carbon for all the compartments. It contains a CarbonCompartmentManager instance, which contains in turn a collection of CarbonCompartment objects that can provide their carbon content on their own.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CarbonAccountingTool.CATMode

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	englishTitle
protected boolean	finalCutHadToBeCarriedOut
protected static java.lang.String	frenchTitle
protected CATFrame	guiInterface
protected static boolean	hasAlreadyBeenInstanciated
protected java.awt.Window	owner
protected java.awt.Window	parentFrame
protected java.util.List<CATCompatibleStand>	waitingStandList

Fields inherited from class repicea.app.AbstractGenericEngine

finalTask, logger, queue, tasksDone

Constructor Summary

Constructors

Constructor and Description
CarbonAccountingTool() Constructor for stand alone application.
CarbonAccountingTool(CarbonAccountingTool.CATMode mode) Generic constructor.

Method Summary

Modifier and Type	Method and Description
void	calculateCarbon() This method launches the calculation of the different carbon compartments.
CATExportTool	createExportTool() This method returns an export tool adapted to the carbon accounting tool.
protected void	decideWhatToDoInCaseOfFailure(GenericTask task) This method is called whenever an exception is thrown while running a task.
protected java.util.Vector<TreeLoggerDescription>	findMatchingTreeLoggers(TreeLoggerCompatibilityCheck check)
protected void	firstTasksToDo() This method sets the first tasks to execute when the engine starts.
protected CATCompartmentManager	getCarbonCompartmentManager()
protected CATSettings	getCarbonToolSettings() This method returns the settings of the carbon accounting tool.
CATFrame	getUI() This method returns the GUI interface of the class that implements this interface.
CATFrame	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
void	initializeTool() Initializes CAT without parent window.
void	initializeTool(java.awt.Window parentFrame) This method initializes the carbon accounting tool either in script or in GUI mode.
protected boolean	isGuiEnabled()
boolean	isInitialized() This method returns true if this CAT instance has been initialized or false otherwise
boolean	isShuttedDown() This method returns true if CAT has been shutted down or false otherwise.
boolean	isVisible() This method returns true if the GUI is visible.
protected void	lockEngine() This method locks the engine while the interface can be doing something else.
static void	main(java.lang.String[] args)
protected void	respondToWindowClosing() By default, closing the gui shuts the engine down.
CATSimulationResult	retrieveSimulationSummary() This method retrieves the simulation results after calling the calculateCarbon method.
protected void	setBiomassParameters()
void	setBiomassParameters(java.lang.String filename) This method sets the biomass parameters for the next simulation in script mode.
protected void	setFinalCutHadToBeCarriedOut(boolean finalCutHadToBeCarriedOut)
protected void	setProductionManager()
void	setProductionManager(java.lang.String filename) This method sets the production lines for the next simulation in script mode.
protected void	setStandList()
void	setStandList(java.util.List<CATCompatibleStand> standList) This method sets the list of stands from which the carbon balance should be calculated.
void	setVariabilitySource(CATSensitivityAnalysisSettings.VariabilitySource source, Distribution.Type type, boolean enabled) This method sets the different parameters of the sensitivity analysis at the level suggested by the IPCC.
void	setVariabilitySource(CATSensitivityAnalysisSettings.VariabilitySource source, Distribution.Type type, boolean enabled, double multiplier) This method sets the different parameters of the sensitivity analysis
void	setVerboseEnabled(boolean bool) This method enables messages all along the process chain.
protected void	showResult()
void	showUI() This method shows the GUI interface of the class that implements this interface.
void	showUI(java.awt.Window parent) This method shows the GUI interface of the class that implements this interface.
protected void	shutdown(int shutdownCode)
protected void	unlockEngine() This method unlock the engine if locked.

Methods inherited from class repicea.app.AbstractGenericEngine

addTask, addTasks, cancelRunningTask, getSettingMemory, lockEngine, requestShutdown, setSettingMemory, startApplication

Methods inherited from class java.lang.Object

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

Field Detail

englishTitle

protected static final java.lang.String englishTitle

See Also:

Constant Field Values

frenchTitle

protected static final java.lang.String frenchTitle

See Also:

Constant Field Values

hasAlreadyBeenInstanciated

protected static boolean hasAlreadyBeenInstanciated

finalCutHadToBeCarriedOut

protected boolean finalCutHadToBeCarriedOut

parentFrame

protected java.awt.Window parentFrame

waitingStandList

protected java.util.List<CATCompatibleStand> waitingStandList

guiInterface

protected transient CATFrame guiInterface

owner

protected transient java.awt.Window owner

Constructor Detail

CarbonAccountingTool

public CarbonAccountingTool()

Constructor for stand alone application.

CarbonAccountingTool

public CarbonAccountingTool(CarbonAccountingTool.CATMode mode)

Generic constructor.

Parameters:

mode - defines how CAT is to be used. See the CATMode enum variable.

Method Detail

shutdown

protected void shutdown(int shutdownCode)

Overrides:

shutdown in class AbstractGenericEngine

isShuttedDown

public boolean isShuttedDown()

This method returns true if CAT has been shutted down or false otherwise.

Returns:

a boolean

getCarbonToolSettings

protected CATSettings getCarbonToolSettings()

This method returns the settings of the carbon accounting tool.

Returns:

a CarbonAccountingToolSettings instance

setVerboseEnabled

public void setVerboseEnabled(boolean bool)

This method enables messages all along the process chain. By default, the verbose is disabled

Parameters:

bool -

initializeTool

public void initializeTool()
                    throws java.lang.Exception

Initializes CAT without parent window.

Throws:

java.lang.Exception

initializeTool

public void initializeTool(java.awt.Window parentFrame)
                    throws java.lang.Exception

This method initializes the carbon accounting tool either in script or in GUI mode. This method can be called only once per instance.

Parameters:

parentFrame - the parent frame which can be null

Throws:

java.lang.Exception

setStandList

public void setStandList(java.util.List<CATCompatibleStand> standList)

This method sets the list of stands from which the carbon balance should be calculated.

Parameters:

standList - a List of CarbonToolCompatibleStand instance

setStandList

protected void setStandList()

findMatchingTreeLoggers

protected java.util.Vector<TreeLoggerDescription> findMatchingTreeLoggers(TreeLoggerCompatibilityCheck check)

firstTasksToDo

protected void firstTasksToDo()

Description copied from class: AbstractGenericEngine

This method sets the first tasks to execute when the engine starts. Typically, it would retrieve the settings, show the user interface and so on.

Specified by:

firstTasksToDo in class AbstractGenericEngine

decideWhatToDoInCaseOfFailure

protected void decideWhatToDoInCaseOfFailure(GenericTask task)

Description copied from class: AbstractGenericEngine

This method is called whenever an exception is thrown while running a task. If the Engine has a user interface and this interface is visible, an error message is displayed. The queue of tasks is cleared.

Overrides:

decideWhatToDoInCaseOfFailure in class AbstractGenericEngine

Parameters:

task - a GenericTask instance

retrieveSimulationSummary

public CATSimulationResult retrieveSimulationSummary()

This method retrieves the simulation results after calling the calculateCarbon method.

Returns:

a CATSimulationResult instance

getCarbonCompartmentManager

protected CATCompartmentManager getCarbonCompartmentManager()

calculateCarbon

public void calculateCarbon()
                     throws java.security.InvalidParameterException,
                            java.lang.InterruptedException

This method launches the calculation of the different carbon compartments.

Throws:

java.lang.InterruptedException - if the engine lock is interrupted

java.security.InvalidParameterException - if the CarbonToolSettings instance is invalid

isGuiEnabled

protected boolean isGuiEnabled()

unlockEngine

protected void unlockEngine()

Description copied from class: AbstractGenericEngine

This method unlock the engine if locked.

Overrides:

unlockEngine in class AbstractGenericEngine

lockEngine

protected void lockEngine()
                   throws java.lang.InterruptedException

Description copied from class: AbstractGenericEngine

This method locks the engine while the interface can be doing something else. The engine can be locked only if the executing thread is not the internal worker.

Overrides:

lockEngine in class AbstractGenericEngine

Throws:

java.lang.InterruptedException

setFinalCutHadToBeCarriedOut

protected void setFinalCutHadToBeCarriedOut(boolean finalCutHadToBeCarriedOut)

createExportTool

public CATExportTool createExportTool()
                               throws java.lang.Exception

This method returns an export tool adapted to the carbon accounting tool. In script mode, the export tool can then be used to export the data in dbf file format.

Returns:

a CarbonAccountingToolExport instance

Throws:

java.lang.Exception

respondToWindowClosing

protected void respondToWindowClosing()

By default, closing the gui shuts the engine down. This method must be overriden with empty content to disable the automatic shut down.

getUI

public CATFrame getUI(java.awt.Container parent)

Description copied from interface: REpiceaUIObjectWithParent

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

Specified by:

getUI in interface REpiceaUIObjectWithParent

Parameters:

parent - a parent Container instance (can be null)

Returns:

a Component instance

showUI

public void showUI(java.awt.Window parent)

Description copied from interface: REpiceaShowableUIWithParent

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

Specified by:

showUI in interface REpiceaShowableUIWithParent

Parameters:

parent - the parent Window instance (can be null)

getUI

public CATFrame getUI()

Description copied from interface: REpiceaUIObject

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

Specified by:

getUI in interface REpiceaUIObject

Returns:

a Component instance

showUI

public void showUI()

Description copied from interface: REpiceaShowableUI

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

Specified by:

showUI in interface REpiceaShowableUI

showResult

protected void showResult()

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObject

Specified by:

isVisible in interface REpiceaUIObjectWithParent

Returns:

a boolean

setBiomassParameters

public void setBiomassParameters(java.lang.String filename)
                          throws java.lang.InterruptedException

This method sets the biomass parameters for the next simulation in script mode.

Parameters:

filename - a String that defines the filename (.bpf) of the biomass parameters

Throws:

java.lang.InterruptedException

java.io.IOException

setBiomassParameters

protected void setBiomassParameters()
                             throws java.io.IOException

Throws:

java.io.IOException

setProductionManager

public void setProductionManager(java.lang.String filename)
                          throws java.lang.InterruptedException

This method sets the production lines for the next simulation in script mode.

Parameters:

filename - a String that defines the filename (.prl) of the processor manager

Throws:

java.lang.InterruptedException

java.io.IOException

setProductionManager

protected void setProductionManager()
                             throws java.io.IOException

Throws:

java.io.IOException

setVariabilitySource

public void setVariabilitySource(CATSensitivityAnalysisSettings.VariabilitySource source,
                                 Distribution.Type type,
                                 boolean enabled)

This method sets the different parameters of the sensitivity analysis at the level suggested by the IPCC.

Parameters:

source - the source of variability

type - the distribution (either uniform (default) or Gaussian

enabled - true to enable or false to disable

setVariabilitySource

public void setVariabilitySource(CATSensitivityAnalysisSettings.VariabilitySource source,
                                 Distribution.Type type,
                                 boolean enabled,
                                 double multiplier)

This method sets the different parameters of the sensitivity analysis

Parameters:

source - the source of variability

type - the distribution (either uniform (default) or Gaussian

enabled - true to enable or false to disable

multiplier - a value between 0.0 and 0.5 (50%)

isInitialized

public boolean isInitialized()

This method returns true if this CAT instance has been initialized or false otherwise

Returns:

a boolean

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception