lerfob.carbonbalancetool.productionlines

Class CarbonUnit

java.lang.Object

repicea.simulation.processsystem.ProcessUnit<CarbonUnit.Element>

lerfob.carbonbalancetool.productionlines.CarbonUnit

All Implemented Interfaces:

SpeciesNameProvider

Direct Known Subclasses:

EndUseWoodProductCarbonUnit, LandfillCarbonUnit

public class CarbonUnit
extends ProcessUnit<CarbonUnit.Element>
implements SpeciesNameProvider

A CarbonUnit instance is a piece of carbon.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CarbonUnit.CarbonUnitStatus
static class	CarbonUnit.Element

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AllSpecies
protected java.lang.String	samplingUnitID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CarbonUnit(int dateIndex, java.lang.String samplingUnitID, CarbonUnitFeature carbonUnitFeature, AmountMap<CarbonUnit.Element> initialAmounts, java.lang.String speciesName) General constructor.

Method Summary

Modifier and Type	Method and Description
protected void	actualizeCarbon(CATCompartmentManager compartmentManager) This method actualizes the carbon content of this carbon unit.
protected void	addProcessUnit(ProcessUnit<CarbonUnit.Element> unit)
protected void	addStatus(CarbonUnit.CarbonUnitStatus currentStatus)
boolean	equals(java.lang.Object obj) A carbon unit object is considered to be equal if it has the same creation date and the same carbon unit features.
protected CarbonUnitFeature	getCarbonUnitFeature()
protected int	getCreationDate() This method returns the creation date of the product
double[]	getCurrentCarbonArray() This method returns an array that contains the current carbon (tC) or null if the carbon unit has not been actualized.
int	getIndexInTimeScale() This method returns the index on the time scale at which the product has been created.
double	getInitialCarbon() This method returns the carbon (tC) at the creation date.
double	getIntegratedCarbon(CATExponentialFunction decayFunction, MonteCarloSimulationCompliantObject subject) This method calculates the average carbon by integrating the carbon contained in this product over its lifetime.
protected CarbonUnit.CarbonUnitStatus	getLastStatus()
double[]	getReleasedCarbonArray() This method returns the released carbon along in time given the product has been actualized.
java.lang.String	getSpeciesName() This method returns the species name of this tree.
protected CATTimeTable	getTimeTable()
double	getTotalNonRenewableCarbonEmissionsMgCO2Eq() This method returns the emissions in Mg of CO2 Eq.
protected boolean	isActualized()
protected void	setTimeTable(CATTimeTable timeTable)
java.lang.String	toString()

Methods inherited from class repicea.simulation.processsystem.ProcessUnit

getAmountMap

Methods inherited from class java.lang.Object

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

Field Detail

AllSpecies

public static final java.lang.String AllSpecies

See Also:

Constant Field Values

samplingUnitID

protected final java.lang.String samplingUnitID

Constructor Detail

CarbonUnit

protected CarbonUnit(int dateIndex,
                     java.lang.String samplingUnitID,
                     CarbonUnitFeature carbonUnitFeature,
                     AmountMap<CarbonUnit.Element> initialAmounts,
                     java.lang.String speciesName)

General constructor.

Parameters:

dateIndex - the creation date index of the time scale

samplingUnitID - the id of the sample unit

carbonUnitFeature - a CarbonUnitFeature instance

initialAmounts - a map that contains the amount of each element to be processed

speciesName - the name of the species

Method Detail

addProcessUnit

protected void addProcessUnit(ProcessUnit<CarbonUnit.Element> unit)

Overrides:

addProcessUnit in class ProcessUnit<CarbonUnit.Element>

isActualized

protected boolean isActualized()

getSpeciesName

public java.lang.String getSpeciesName()

Description copied from interface: SpeciesNameProvider

This method returns the species name of this tree.

Specified by:

getSpeciesName in interface SpeciesNameProvider

Returns:

a String

getCreationDate

protected int getCreationDate()

This method returns the creation date of the product

Returns:

an integer

setTimeTable

protected void setTimeTable(CATTimeTable timeTable)

getTimeTable

protected CATTimeTable getTimeTable()

getCarbonUnitFeature

protected CarbonUnitFeature getCarbonUnitFeature()

getInitialCarbon

public double getInitialCarbon()

This method returns the carbon (tC) at the creation date. NOTE: For the landfill carbon, only the degradable organic carbon is considered.

Returns:

a double

getCurrentCarbonArray

public double[] getCurrentCarbonArray()

This method returns an array that contains the current carbon (tC) or null if the carbon unit has not been actualized.

Returns:

an array of double

getIntegratedCarbon

public double getIntegratedCarbon(CATExponentialFunction decayFunction,
                                  MonteCarloSimulationCompliantObject subject)

This method calculates the average carbon by integrating the carbon contained in this product over its lifetime.

Returns:

the integrated carbon in tC (double)

actualizeCarbon

protected void actualizeCarbon(CATCompartmentManager compartmentManager)
                        throws java.lang.Exception

This method actualizes the carbon content of this carbon unit.

Parameters:

compartmentManager - a CATCompartmentManager instance

Throws:

java.lang.Exception

getReleasedCarbonArray

public double[] getReleasedCarbonArray()

This method returns the released carbon along in time given the product has been actualized. Otherwise it returns null.

Returns:

an array of double that contains the released carbon (tC)

equals

public boolean equals(java.lang.Object obj)

A carbon unit object is considered to be equal if it has the same creation date and the same carbon unit features.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLastStatus

protected CarbonUnit.CarbonUnitStatus getLastStatus()

addStatus

protected void addStatus(CarbonUnit.CarbonUnitStatus currentStatus)

getTotalNonRenewableCarbonEmissionsMgCO2Eq

public double getTotalNonRenewableCarbonEmissionsMgCO2Eq()

This method returns the emissions in Mg of CO2 Eq.

Returns:

a double

getIndexInTimeScale

public int getIndexInTimeScale()

This method returns the index on the time scale at which the product has been created.

Returns:

an Integer