lerfob.carbonbalancetool.pythonaccess

Class PythonAccessPoint

java.lang.Object

repicea.app.AbstractGenericEngine

lerfob.carbonbalancetool.CarbonAccountingTool

lerfob.carbonbalancetool.pythonaccess.PythonAccessPoint

All Implemented Interfaces:

REpiceaShowableUI, REpiceaShowableUIWithParent, REpiceaUIObject, REpiceaUIObjectWithParent

public class PythonAccessPoint
extends CarbonAccountingTool

This class is the entry point for a coupling with a Python application. Once exported as a .jar with the main function set to this class, the entry point should use the method processStandList(Map myMap).

Nested Class Summary

Nested classes/interfaces inherited from class lerfob.carbonbalancetool.CarbonAccountingTool

CarbonAccountingTool.CATMode

Field Summary

Fields

Modifier and Type	Field and Description
protected double	areaHa
protected CATSettings.CATSpecies	speciesForSimulation

Fields inherited from class lerfob.carbonbalancetool.CarbonAccountingTool

englishTitle, finalCutHadToBeCarriedOut, frenchTitle, guiInterface, hasAlreadyBeenInstanciated, owner, parentFrame, waitingStandList

Fields inherited from class repicea.app.AbstractGenericEngine

finalTask, logger, queue, tasksDone

Constructor Summary

Constructors

Constructor and Description
PythonAccessPoint()

Method Summary

Modifier and Type	Method and Description
protected java.util.Vector<TreeLoggerDescription>	findMatchingTreeLoggers(TreeLoggerCompatibilityCheck referent)
protected static double	getAverageDryBiomassByTree(double kgM2, double nbTreesHa)
protected CATSettings	getCarbonToolSettings() This method returns the settings of the carbon accounting tool.
java.lang.String	getRevision() This method returns the version of the lerfob-cat application.
static void	main(java.lang.String[] args) Start method for connection to Python.
java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.Double>>	processStandList(java.lang.String standID, java.util.Map inputMap)
protected void	respondToWindowClosing() By default, closing the gui shuts the engine down.
void	setAreaHA(double areaHa) This method sets the area of the plot to be processed.
void	setSpecies(java.lang.String species) This method sets the species for the simulation
protected void	shutdown(int shutdownCode)

Methods inherited from class lerfob.carbonbalancetool.CarbonAccountingTool

calculateCarbon, createExportTool, decideWhatToDoInCaseOfFailure, firstTasksToDo, getCarbonCompartmentManager, getUI, getUI, initializeTool, initializeTool, isGuiEnabled, isInitialized, isShuttedDown, isVisible, lockEngine, retrieveSimulationSummary, setBiomassParameters, setBiomassParameters, setFinalCutHadToBeCarriedOut, setProductionManager, setProductionManager, setStandList, setStandList, setVariabilitySource, setVariabilitySource, setVerboseEnabled, showResult, showUI, showUI, unlockEngine

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

speciesForSimulation

protected CATSettings.CATSpecies speciesForSimulation

areaHa

protected double areaHa

Constructor Detail

PythonAccessPoint

public PythonAccessPoint()
                  throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

setSpecies

public void setSpecies(java.lang.String species)
                throws java.lang.Exception

This method sets the species for the simulation

Parameters:

species - a String either "beech" or "pine"

Throws:

java.io.IOException

java.lang.Exception

setAreaHA

public void setAreaHA(double areaHa)

This method sets the area of the plot to be processed. By default, this area is set to 1 ha.

Parameters:

areaHa - the area (ha)

findMatchingTreeLoggers

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

Overrides:

findMatchingTreeLoggers in class CarbonAccountingTool

getCarbonToolSettings

protected CATSettings getCarbonToolSettings()

Description copied from class: CarbonAccountingTool

This method returns the settings of the carbon accounting tool.

Overrides:

getCarbonToolSettings in class CarbonAccountingTool

Returns:

a CarbonAccountingToolSettings instance

shutdown

protected void shutdown(int shutdownCode)

Overrides:

shutdown in class CarbonAccountingTool

processStandList

public java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.Double>> processStandList(java.lang.String standID,
                                                                                                          java.util.Map inputMap)
                                                                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getAverageDryBiomassByTree

protected static double getAverageDryBiomassByTree(double kgM2,
                                                   double nbTreesHa)

respondToWindowClosing

protected void respondToWindowClosing()

Description copied from class: CarbonAccountingTool

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

Overrides:

respondToWindowClosing in class CarbonAccountingTool

getRevision

public java.lang.String getRevision()

This method returns the version of the lerfob-cat application.

Returns:

a String

main

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

Start method for connection to Python.

Parameters:

args -

Throws:

java.lang.Exception