lerfob.predictor.volume.frenchcommercialvolume2020

Class FrenchCommercialVolume2020TreeImpl

java.lang.Object

lerfob.predictor.volume.frenchcommercialvolume2020.FrenchCommercialVolume2020TreeImpl

All Implemented Interfaces:

FrenchCommercialVolume2020Tree, DbhCmProvider, HeightMProvider, SquaredDbhCmProvider, MonteCarloSimulationCompliantObject

public class FrenchCommercialVolume2020TreeImpl
extends java.lang.Object
implements FrenchCommercialVolume2020Tree

A basic implementation of the FrenchCommercialVolume2020Tree interface.

Nested Class Summary

Nested classes/interfaces inherited from interface lerfob.predictor.volume.frenchcommercialvolume2020.FrenchCommercialVolume2020Tree

FrenchCommercialVolume2020Tree.FrenchCommercialVolume2020TreeSpecies

Constructor Summary

Constructors

Modifier	Constructor and Description
	FrenchCommercialVolume2020TreeImpl(int id, double dbhCm, double heightM, java.lang.String speciesName) Public constructor
protected	FrenchCommercialVolume2020TreeImpl(int id, double dbhCm, double heightM, java.lang.String speciesName, double pred, double se, double var) Protected constructor

Method Summary

Modifier and Type	Method and Description
double	getDbhCm() This method returns the diameter at breast height of the tree.
FrenchCommercialVolume2020Tree.FrenchCommercialVolume2020TreeSpecies	getFrenchCommercialVolume2020TreeSpecies() This method returns the species of the tree instance.
double	getHeightM() This method returns the tree height in m.
int	getMonteCarloRealizationId() This method returns the id of the Monte Carlo realization.
double	getSquaredDbhCm() This method returns the square of dbh.
java.lang.String	getSubjectId() This method returns an object that makes it possible to identify the subject that implements this interface.

Methods inherited from class java.lang.Object

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

Methods inherited from interface lerfob.predictor.volume.frenchcommercialvolume2020.FrenchCommercialVolume2020Tree

getHierarchicalLevel

Constructor Detail

FrenchCommercialVolume2020TreeImpl

protected FrenchCommercialVolume2020TreeImpl(int id,
                                             double dbhCm,
                                             double heightM,
                                             java.lang.String speciesName,
                                             double pred,
                                             double se,
                                             double var)

Protected constructor

Parameters:

id - an integer that stands for the tree id

dbhCm - the diameter at breast height (cm)

heightM - the tree height (m)

speciesName - the species name. It should be an enum name among the FrenchCommercialVolume2020TreeSpecies enum variable (e.g. Pinus halepensis).

pred - an optional prediction for test purposes.

se - the standard error of the prediction for test purposes.

se - prediction variance (mean + residual) for test purposes.

FrenchCommercialVolume2020TreeImpl

public FrenchCommercialVolume2020TreeImpl(int id,
                                          double dbhCm,
                                          double heightM,
                                          java.lang.String speciesName)

Public constructor

Parameters:

id - an integer that stands for the tree id

dbhCm - the diameter at breast height (cm)

heightM - the tree height (m)

speciesName - the species name. It should be an enum name among the FrenchCommercialVolume2020TreeSpecies enum variable (e.g. Pinus halepensis).

Method Detail

getDbhCm

public double getDbhCm()

Description copied from interface: DbhCmProvider

This method returns the diameter at breast height of the tree.

Specified by:

getDbhCm in interface DbhCmProvider

Returns:

the dbh in cm (double)

getSquaredDbhCm

public double getSquaredDbhCm()

Description copied from interface: SquaredDbhCmProvider

This method returns the square of dbh.

Specified by:

getSquaredDbhCm in interface SquaredDbhCmProvider

Returns:

the square of dbh in cm2 (double)

getHeightM

public double getHeightM()

Description copied from interface: HeightMProvider

This method returns the tree height in m.

Specified by:

getHeightM in interface HeightMProvider

Returns:

the height in m (double)

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

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

getFrenchCommercialVolume2020TreeSpecies

public FrenchCommercialVolume2020Tree.FrenchCommercialVolume2020TreeSpecies getFrenchCommercialVolume2020TreeSpecies()

Description copied from interface: FrenchCommercialVolume2020Tree

This method returns the species of the tree instance.

Specified by:

getFrenchCommercialVolume2020TreeSpecies in interface FrenchCommercialVolume2020Tree

Returns:

a FrenchCommercialVolume2020TreeSpecies enum instance