lerfob.carbonbalancetool

Class CATCompartment

java.lang.Object

lerfob.carbonbalancetool.CATCompartment

All Implemented Interfaces:

java.lang.Comparable

Direct Known Subclasses:

CATProductCompartment

public class CATCompartment
extends java.lang.Object
implements java.lang.Comparable

The CarbonCompartment class handles the calculation of the carbon content for the different compartment (root, aboveground, wood products, etc.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CATCompartment.CompartmentInfo This enum contains basic information on the carbon compartments.
protected static class	CATCompartment.PoolCategory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CATCompartment(CATCompartmentManager compartmentManager, CATCompartment.CompartmentInfo compartmentInfo) General constructor for a CarbonCompartment object.

Method Summary

Modifier and Type	Method and Description
protected void	addFatherCompartment(CATCompartment carbonCompartment)
void	calculateAndIntegrateCarbon() This method calculates and integrates the carbon for this compartment by calling the method library and using the appropriate method.
int	compareTo(java.lang.Object o)
protected double[]	getCalculatedCarbonArray()
protected Matrix	getCarbonEvolution(double plotAreaHa) This method return a Matrix with the carbon stock per ha.
protected java.util.Collection<? extends CarbonUnit>[]	getCarbonUnitsArray()
CATCompartment.CompartmentInfo	getCompartmentID()
CATCompartmentManager	getCompartmentManager()
java.util.List<CATCompartment>	getFatherCompartment()
protected double	getIntegratedCarbon()
double	getIntegratedCarbon(double plotAreaHa) This method returns a random variable that contains the integrated carbon per ha.
protected CATTimeTable	getTimeTable()
protected void	mergeWithFatherCompartments() This method merges the carbon values of the father compartments into this compartment.
protected void	resetCarbon() This method initializes the carbon map array.
protected void	setCarbonIntoArray(int indexDate, double d)
protected void	setCarbonUnitsArray(java.util.Collection<? extends CarbonUnit>[] carbonUnitsCollectionArray)
protected void	setIntegratedCarbon(double integratedCarbon)

Methods inherited from class java.lang.Object

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

Constructor Detail

CATCompartment

protected CATCompartment(CATCompartmentManager compartmentManager,
                         CATCompartment.CompartmentInfo compartmentInfo)

General constructor for a CarbonCompartment object.

Parameters:

compartmentManager - = the compartment manager that handles this compartment

compartmentInfo - = the compartment info of this compartment

Method Detail

getCompartmentID

public CATCompartment.CompartmentInfo getCompartmentID()

getCompartmentManager

public CATCompartmentManager getCompartmentManager()

addFatherCompartment

protected void addFatherCompartment(CATCompartment carbonCompartment)

getCalculatedCarbonArray

protected double[] getCalculatedCarbonArray()

getIntegratedCarbon

protected double getIntegratedCarbon()

setIntegratedCarbon

protected void setIntegratedCarbon(double integratedCarbon)

setCarbonUnitsArray

protected void setCarbonUnitsArray(java.util.Collection<? extends CarbonUnit>[] carbonUnitsCollectionArray)

getCarbonUnitsArray

protected java.util.Collection<? extends CarbonUnit>[] getCarbonUnitsArray()

resetCarbon

protected void resetCarbon()

This method initializes the carbon map array.

getCarbonEvolution

protected Matrix getCarbonEvolution(double plotAreaHa)

This method return a Matrix with the carbon stock per ha.

Parameters:

plotAreaHa - the area of the plot in ha

Returns:

a Matrix instance

getIntegratedCarbon

public double getIntegratedCarbon(double plotAreaHa)

This method returns a random variable that contains the integrated carbon per ha.

Parameters:

plotAreaHa - the plot area in ha (double)

Returns:

a double

setCarbonIntoArray

protected void setCarbonIntoArray(int indexDate,
                                  double d)

mergeWithFatherCompartments

protected void mergeWithFatherCompartments()

This method merges the carbon values of the father compartments into this compartment.

getFatherCompartment

public java.util.List<CATCompartment> getFatherCompartment()

calculateAndIntegrateCarbon

public void calculateAndIntegrateCarbon()
                                 throws java.lang.Exception

This method calculates and integrates the carbon for this compartment by calling the method library and using the appropriate method.

Throws:

java.lang.Exception

getTimeTable

protected CATTimeTable getTimeTable()

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable