lerfob.carbonbalancetool

Class CATCompartmentManager

java.lang.Object

lerfob.carbonbalancetool.CATCompartmentManager

All Implemented Interfaces:

MonteCarloSimulationCompliantObject

public class CATCompartmentManager
extends java.lang.Object
implements MonteCarloSimulationCompliantObject

Field Summary

Fields

Modifier and Type	Field and Description
protected lerfob.carbonbalancetool.CATSingleSimulationResult	summary

Constructor Summary

Constructors

Constructor and Description
CATCompartmentManager(CATSettings settings) Constructor for this class

Method Summary

Modifier and Type	Method and Description
CATSettings	getCarbonToolSettings()
java.util.Map<CATCompartment.CompartmentInfo,CATCompartment>	getCompartments()
protected int	getDateIndexForThisTree(CATCompatibleTree tree)
HierarchicalLevel	getHierarchicalLevel() This method returns the hierarchical levels of the object.
CATCompatibleStand	getLastStand() This method returns the last stand from the list of stands.
int	getMonteCarloRealizationId() This method returns the id of the Monte Carlo realization.
int	getRotationLength() This method returns the rotation length in year.
protected lerfob.carbonbalancetool.CATSingleSimulationResult	getSimulationSummary() This method returns a summary of simulation.
protected java.util.List<java.lang.String>	getSpeciesList()
protected java.util.List<CATCompatibleStand>	getStandList()
java.lang.String	getSubjectId() This method returns an object that makes it possible to identify the subject that implements this interface.
CATTimeTable	getTimeTable() This method returns the TimeScale instance the simulation has been run with.
protected java.util.Map<CATCompatibleStand,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Collection<CATCompatibleTree>>>>	getTrees(TreeStatusProvider.StatusClass statusClass)
void	init(java.util.List<CATCompatibleStand> stands)
protected boolean	isEvenAged()
protected void	registerTree(TreeStatusProvider.StatusClass statusClass, CATCompatibleStand stand, CATCompatibleTree tree)
protected void	registerTreeSpecies(CATCompatibleTree tree)
void	resetCompartmentsAndSetCarbonUnitCollections()
protected void	resetManager()
protected void	setRealization(int realizationID)
protected void	setSimulationValid(boolean isSimulationValid)
protected void	storeResults()

Methods inherited from class java.lang.Object

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

Field Detail

summary

protected lerfob.carbonbalancetool.CATSingleSimulationResult summary

Constructor Detail

CATCompartmentManager

public CATCompartmentManager(CATSettings settings)

Constructor for this class

Parameters:

settings - a CATSettings instance

Method Detail

registerTree

protected void registerTree(TreeStatusProvider.StatusClass statusClass,
                            CATCompatibleStand stand,
                            CATCompatibleTree tree)

getDateIndexForThisTree

protected int getDateIndexForThisTree(CATCompatibleTree tree)

getTrees

protected java.util.Map<CATCompatibleStand,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Collection<CATCompatibleTree>>>> getTrees(TreeStatusProvider.StatusClass statusClass)

getSpeciesList

protected java.util.List<java.lang.String> getSpeciesList()

registerTreeSpecies

protected void registerTreeSpecies(CATCompatibleTree tree)

setSimulationValid

protected void setSimulationValid(boolean isSimulationValid)

init

public void init(java.util.List<CATCompatibleStand> stands)

resetManager

protected void resetManager()

getTimeTable

public CATTimeTable getTimeTable()

This method returns the TimeScale instance the simulation has been run with.

Returns:

a CATTimeTable instance

getCarbonToolSettings

public CATSettings getCarbonToolSettings()

resetCompartmentsAndSetCarbonUnitCollections

public void resetCompartmentsAndSetCarbonUnitCollections()

getCompartments

public java.util.Map<CATCompartment.CompartmentInfo,CATCompartment> getCompartments()

getLastStand

public CATCompatibleStand getLastStand()

This method returns the last stand from the list of stands.

Returns:

a CarbonToolCompatibleStand or null if the list is null or empty

getStandList

protected java.util.List<CATCompatibleStand> getStandList()

getRotationLength

public int getRotationLength()

This method returns the rotation length in year.

Returns:

an integer

getSimulationSummary

protected lerfob.carbonbalancetool.CATSingleSimulationResult getSimulationSummary()

This method returns a summary of simulation.

Returns:

a CarbonAccountingToolExportSummary instance if the simulation has been carried out or null otherwise

storeResults

protected void storeResults()

isEvenAged

protected boolean isEvenAged()

setRealization

protected void setRealization(int realizationID)

getMonteCarloRealizationId

public int getMonteCarloRealizationId()

Description copied from interface: MonteCarloSimulationCompliantObject

This method returns the id of the Monte Carlo realization. It is necessary for the implementation of the random deviates on the parameter estimates. These deviates remain constant for a particular Monte Carlo iteration, regardless of the plot.

Specified by:

getMonteCarloRealizationId in interface MonteCarloSimulationCompliantObject

Returns:

an integer

getSubjectId

public java.lang.String getSubjectId()

Description copied from interface: MonteCarloSimulationCompliantObject

This method returns an object that makes it possible to identify the subject that implements this interface. This id remains constant throughout the Monte Carlo iterations in case of stochastic implementation.

Specified by:

getSubjectId in interface MonteCarloSimulationCompliantObject

Returns:

a String that defines the subject id and that remains constant throughout the simulation

getHierarchicalLevel

public HierarchicalLevel getHierarchicalLevel()

Description copied from interface: MonteCarloSimulationCompliantObject

This method returns the hierarchical levels of the object.

Specified by:

getHierarchicalLevel in interface MonteCarloSimulationCompliantObject

Returns:

a HierarchicalLevel instance