lerfob.carbonbalancetool

Interface CATSimulationResult

All Known Implementing Classes:

CATSimulationDifference

public interface CATSimulationResult

The CarbonAssessmentToolSimulationResult interface ensures the object can provide the results of a carbon simulation.

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.

Method Detail

isValid

boolean isValid()

Returns false if the simulation went wrong at some place.

Returns:

a boolean

getBudgetMap

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

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

Returns:

a Map with CompartmentInfo and Double as keys and values

getStandID

java.lang.String getStandID()

This method return the identifier of the stand.

Returns:

a String

getTimeTable

CATTimeTable getTimeTable()

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

Returns:

a TimeScale instance

getRotationLength

int getRotationLength()

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

Returns:

an integer

getEvolutionMap

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

This method returns the carbon stock evolution in each compartment.

Returns:

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

getHWPPerHaByUseClass

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...)

Returns:

a Map with CarbonUnitType and Maps as keys and values

getLogGradePerHa

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.

Returns:

a Map instance

getProductEvolutionPerHa

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

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

Returns:

a Map of integer and maps.

getResultId

java.lang.String getResultId()

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

Returns:

a String

getHWPSummaryPerHa

CATUtilityMaps.UseClassSpeciesMonteCarloEstimateMap getHWPSummaryPerHa(boolean includeRecycling)

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

Parameters:

includeRecycling - a boolean

Returns:

a Map of Useclass and Map instances

isEvenAged

boolean isEvenAged()

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

Returns:

a boolean

getHeatProductionEvolutionKWhPerHa

MonteCarloEstimate getHeatProductionEvolutionKWhPerHa()

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

Returns:

a MonteCarlo estimate