lerfob.carbonbalancetool

Class CATSimulationDifference

java.lang.Object

lerfob.carbonbalancetool.CATSimulationDifference

All Implemented Interfaces:

CATSimulationResult

public class CATSimulationDifference
extends java.lang.Object
implements CATSimulationResult

The CarbonAssessmentToolSimulationDifference class handles differences between two scenarios and provides the results.

Method Summary

Modifier and Type	Method and Description
java.util.Map<CATCompartment.CompartmentInfo,Estimate<?>>	getBudgetMap() This method returns the "rotation-averaged" carbon stocks in each compartment.
java.util.Map<CATCompartment.CompartmentInfo,MonteCarloEstimate>	getEvolutionMap() This method returns the carbon stock evolution in each compartment.
MonteCarloEstimate	getHeatProductionEvolutionKWhPerHa() This method returns the heat production (KWh) for one ha.
java.util.Map<CarbonUnit.CarbonUnitStatus,CATUtilityMaps.UseClassSpeciesMonteCarloEstimateMap>	getHWPPerHaByUseClass() This method returns the amount of harvested wood products (HWPs) by use class and type (recycled, residues, etc...)
CATUtilityMaps.UseClassSpeciesMonteCarloEstimateMap	getHWPSummaryPerHa(boolean includeRecycling) This method returns the summary of the HWP with or without recycling.
java.util.Map<java.lang.String,CATUtilityMaps.SpeciesMonteCarloEstimateMap>	getLogGradePerHa() This method returns total volume and biomass by log grade categories over the simulation period or rotation.
java.util.Map<java.lang.Integer,CATUtilityMaps.UseClassSpeciesMonteCarloEstimateMap>	getProductEvolutionPerHa() This method returns the HWPs by use class at the different steps of the simulation.
java.lang.String	getResultId() This method returns the result id for this instance.
int	getRotationLength() This method returns either the rotation length (to the final cut) or the projection length in case of uneven-aged stand.
java.lang.String	getStandID() This method return the identifier of the stand.
CATTimeTable	getTimeTable() This method returns an array with the date or age of the carbon simulation.
boolean	isEvenAged() This method returns the nature of the CarbonToolCompatibleStand stand.
boolean	isValid() Returns false if the simulation went wrong at some place.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getBudgetMap

public java.util.Map<CATCompartment.CompartmentInfo,Estimate<?>> getBudgetMap()

Description copied from interface: CATSimulationResult

This method returns the "rotation-averaged" carbon stocks in each compartment.

Specified by:

getBudgetMap in interface CATSimulationResult

Returns:

a Map with CompartmentInfo and Double as keys and values

getStandID

public java.lang.String getStandID()

Description copied from interface: CATSimulationResult

This method return the identifier of the stand.

Specified by:

getStandID in interface CATSimulationResult

Returns:

a String

getTimeTable

public CATTimeTable getTimeTable()

Description copied from interface: CATSimulationResult

This method returns an array with the date or age of the carbon simulation.

Specified by:

getTimeTable in interface CATSimulationResult

Returns:

a TimeScale instance

getRotationLength

public int getRotationLength()

Description copied from interface: CATSimulationResult

This method returns either the rotation length (to the final cut) or the projection length in case of uneven-aged stand.

Specified by:

getRotationLength in interface CATSimulationResult

Returns:

an integer

getEvolutionMap

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

Description copied from interface: CATSimulationResult

This method returns the carbon stock evolution in each compartment.

Specified by:

getEvolutionMap in interface CATSimulationResult

Returns:

a Map with CompartmentInfo and array of Doubles as keys and values

getHWPPerHaByUseClass

public java.util.Map<CarbonUnit.CarbonUnitStatus,CATUtilityMaps.UseClassSpeciesMonteCarloEstimateMap> getHWPPerHaByUseClass()

Description copied from interface: CATSimulationResult

This method returns the amount of harvested wood products (HWPs) by use class and type (recycled, residues, etc...)

Specified by:

getHWPPerHaByUseClass in interface CATSimulationResult

Returns:

a Map with CarbonUnitType and Maps as keys and values

getLogGradePerHa

public java.util.Map<java.lang.String,CATUtilityMaps.SpeciesMonteCarloEstimateMap> getLogGradePerHa()

Description copied from interface: CATSimulationResult

This method returns total volume and biomass by log grade categories over the simulation period or rotation.

Specified by:

getLogGradePerHa in interface CATSimulationResult

Returns:

a Map instance

getProductEvolutionPerHa

public java.util.Map<java.lang.Integer,CATUtilityMaps.UseClassSpeciesMonteCarloEstimateMap> getProductEvolutionPerHa()

Description copied from interface: CATSimulationResult

This method returns the HWPs by use class at the different steps of the simulation.

Specified by:

getProductEvolutionPerHa in interface CATSimulationResult

Returns:

a Map of integer and maps.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getResultId

public java.lang.String getResultId()

Description copied from interface: CATSimulationResult

This method returns the result id for this instance. For example, it could be "sim1".

Specified by:

getResultId in interface CATSimulationResult

Returns:

a String

getHWPSummaryPerHa

public CATUtilityMaps.UseClassSpeciesMonteCarloEstimateMap getHWPSummaryPerHa(boolean includeRecycling)

Description copied from interface: CATSimulationResult

This method returns the summary of the HWP with or without recycling.

Specified by:

getHWPSummaryPerHa in interface CATSimulationResult

Parameters:

includeRecycling - a boolean

Returns:

a Map of Useclass and Map instances

isEvenAged

public boolean isEvenAged()

Description copied from interface: CATSimulationResult

This method returns the nature of the CarbonToolCompatibleStand stand. The summary of even-aged stands can be based on infinite sequence.

Specified by:

isEvenAged in interface CATSimulationResult

Returns:

a boolean

getHeatProductionEvolutionKWhPerHa

public MonteCarloEstimate getHeatProductionEvolutionKWhPerHa()

Description copied from interface: CATSimulationResult

This method returns the heat production (KWh) for one ha.

Specified by:

getHeatProductionEvolutionKWhPerHa in interface CATSimulationResult

Returns:

a MonteCarlo estimate

isValid

public boolean isValid()

Description copied from interface: CATSimulationResult

Returns false if the simulation went wrong at some place.

Specified by:

isValid in interface CATSimulationResult

Returns:

a boolean