lerfob.carbonbalancetool

Class CATSettings

java.lang.Object

lerfob.carbonbalancetool.CATSettings

public final class CATSettings
extends java.lang.Object

The CarbonAccountingToolSettings class handles the production lines, the wood piece dispatcher and the biomass parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CATSettings.AssessmentReport
static class	CATSettings.CATSpecies The enum representing the species.
static class	CATSettings.GWP

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<CATUtility.BiomassParametersName,lerfob.carbonbalancetool.CATUtility.BiomassParametersWrapper>	biomassParametersMap
static double	C_C02_FACTOR
static double	C_CH4_FACTOR
static double	CH4_C_FACTOR
static double	CO2_C_FACTOR
protected CATUtility.BiomassParametersName	currentBiomassParameters
protected CATUtility.ProductionManagerName	currentProcessorManager
protected boolean	formerImplementation
protected java.util.Map<CATUtility.ProductionManagerName,CATUtility.ProductionProcessorManagerWrapper>	productionManagerMap
protected static CATSettings.AssessmentReport	selectedAR

Constructor Summary

Constructors

Constructor and Description
CATSettings(SettingMemory settings) Constructor.

Method Summary

Modifier and Type	Method and Description
BiomassParameters	getCurrentBiomassParameters() This method returns the currently selected BiomassParameters instance.
ProductionProcessorManager	getCurrentProductionProcessorManager() This method returns the currently selected ProductionProcessorManager instance.
protected BiomassParameters	getCustomizableBiomassParameters() This method returns the customizable biomass parameters manager.
protected ProductionProcessorManager	getCustomizableProductionProcessorManager() This method returns the customizable production manager.
CATExponentialFunction	getDecayFunction()
static CATSettings.GWP	getGlobalWarmingPotential() This method returns the Global Warming Potential according to the selected assessment report.
protected ProductionLineManager	getProductionLines() Deprecated.
protected SettingMemory	getSettingMemory()
TreeLogger<?,?>	getTreeLogger() This method returns the TreeLogger instance of the settings.
protected java.util.Vector<TreeLoggerDescription>	getTreeLoggerDescriptions() Deprecated.
protected WoodPieceDispatcher	getWoodSupplySetup() Deprecated.
void	initialize(TreeLogger treeLogger, java.lang.String productionLinesFilename, java.lang.String woodDispatcherFilename) Deprecated.
boolean	isValid() This method returns true if the settings are valid.
boolean	isVerboseEnabled()
static void	setAssessmentReportForGWP(CATSettings.AssessmentReport aR) This method set the assessment report for the Global Warming Potential factors.
void	setHarvestVolumeMethod(java.lang.Object selectedItem) Deprecated.
void	setProductionLines(java.lang.Object selectedItem) Deprecated.
protected void	setReferentForBiomassParameters(java.lang.Object referent)
void	setTreeLoggerDescriptions(java.util.Vector<TreeLoggerDescription> treeLoggerDescriptions) This method sets the possible tree logger options.
protected void	setVerboseEnabled(boolean bool)
void	setWoodSupply(java.lang.Object selectedItem) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

formerImplementation

protected boolean formerImplementation

CO2_C_FACTOR

public static final double CO2_C_FACTOR

See Also:

Constant Field Values

C_C02_FACTOR

public static final double C_C02_FACTOR

See Also:

Constant Field Values

CH4_C_FACTOR

public static final double CH4_C_FACTOR

See Also:

Constant Field Values

C_CH4_FACTOR

public static final double C_CH4_FACTOR

See Also:

Constant Field Values

selectedAR

protected static CATSettings.AssessmentReport selectedAR

productionManagerMap

protected final java.util.Map<CATUtility.ProductionManagerName,CATUtility.ProductionProcessorManagerWrapper> productionManagerMap

biomassParametersMap

protected final java.util.Map<CATUtility.BiomassParametersName,lerfob.carbonbalancetool.CATUtility.BiomassParametersWrapper> biomassParametersMap

currentProcessorManager

protected CATUtility.ProductionManagerName currentProcessorManager

currentBiomassParameters

protected CATUtility.BiomassParametersName currentBiomassParameters

Constructor Detail

CATSettings

public CATSettings(SettingMemory settings)

Constructor.

Method Detail

getGlobalWarmingPotential

public static CATSettings.GWP getGlobalWarmingPotential()

This method returns the Global Warming Potential according to the selected assessment report.

Returns:

a GWP instance

setAssessmentReportForGWP

public static void setAssessmentReportForGWP(CATSettings.AssessmentReport aR)

This method set the assessment report for the Global Warming Potential factors.

Parameters:

aR - an AssessmentReport enum variable

getCustomizableProductionProcessorManager

protected ProductionProcessorManager getCustomizableProductionProcessorManager()

This method returns the customizable production manager.

Returns:

a ProductionProcessorManager instance

getCustomizableBiomassParameters

protected BiomassParameters getCustomizableBiomassParameters()

This method returns the customizable biomass parameters manager.

Returns:

a BiomassParameters instance

getCurrentProductionProcessorManager

public ProductionProcessorManager getCurrentProductionProcessorManager()

This method returns the currently selected ProductionProcessorManager instance.

Returns:

a ProductionProcessorManager instance

getCurrentBiomassParameters

public BiomassParameters getCurrentBiomassParameters()

This method returns the currently selected BiomassParameters instance.

Returns:

a BiomassParameters instance

setTreeLoggerDescriptions

public void setTreeLoggerDescriptions(java.util.Vector<TreeLoggerDescription> treeLoggerDescriptions)

This method sets the possible tree logger options.

Parameters:

treeLoggerDescriptions - a Vector of TreeLoggerDescription instances

setReferentForBiomassParameters

protected void setReferentForBiomassParameters(java.lang.Object referent)

getTreeLoggerDescriptions

@Deprecated
protected java.util.Vector<TreeLoggerDescription> getTreeLoggerDescriptions()

Deprecated.

This method returns the list of possible tree loggers.

Returns:

a Vector of TreeLoggerDescription instances

isValid

public boolean isValid()

This method returns true if the settings are valid.

Returns:

a boolean

getDecayFunction

public CATExponentialFunction getDecayFunction()

getSettingMemory

protected SettingMemory getSettingMemory()

setHarvestVolumeMethod

@Deprecated
public void setHarvestVolumeMethod(java.lang.Object selectedItem)

Deprecated.

This method sets the tree logger instance.

Parameters:

selectedItem - a String (default) or a TreeLoggerDescription instance

setWoodSupply

@Deprecated
public void setWoodSupply(java.lang.Object selectedItem)

Deprecated.

This method sets the wood supply.

Parameters:

selectedItem - the filename without the path (which is assumed to be the workspace)

setProductionLines

@Deprecated
public void setProductionLines(java.lang.Object selectedItem)

Deprecated.

This method sets the production lines.

Parameters:

selectedItem - the filename without the path (which is assumed to be the workspace)

initialize

@Deprecated
public void initialize(TreeLogger treeLogger,
                                   java.lang.String productionLinesFilename,
                                   java.lang.String woodDispatcherFilename)
                            throws java.io.IOException

Deprecated.

This method should be called in script mode.

Parameters:

treeLogger -

productionLinesFilename - the path to the production lines file

woodDispatcherFilename - the path to the wood dispatcher file

Throws:

java.io.IOException

getTreeLogger

public TreeLogger<?,?> getTreeLogger()

This method returns the TreeLogger instance of the settings.

Returns:

a TreeLogger instance

getProductionLines

@Deprecated
protected ProductionLineManager getProductionLines()

Deprecated.

This method returns the production lines.

Returns:

a ProductionLineManager instance

getWoodSupplySetup

@Deprecated
protected WoodPieceDispatcher getWoodSupplySetup()

Deprecated.

This method returns the wood piece dispatcher.

Returns:

a WoodPieceDispatcher instance

setVerboseEnabled

protected void setVerboseEnabled(boolean bool)

isVerboseEnabled

public boolean isVerboseEnabled()