lerfob.carbonbalancetool

Enum CATSettings.CATSpecies

java.lang.Object

java.lang.Enum<CATSettings.CATSpecies>

lerfob.carbonbalancetool.CATSettings.CATSpecies

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CATSettings.CATSpecies>, BarkProportionProvider, BasicWoodDensityProvider, SpeciesTypeProvider

Enclosing class:

CATSettings

public static enum CATSettings.CATSpecies
extends java.lang.Enum<CATSettings.CATSpecies>
implements BasicWoodDensityProvider, SpeciesTypeProvider, BarkProportionProvider

The enum representing the species. The proportion of bark volume was taken from Miles, P.D. and W.B. Smith. 2009. Specific gravity and other properties of wood and bark for 156 tree species found in North America. USDA Forest Service, Northern Research Station. Research Note NRS-38.

Nested Class Summary

Nested classes/interfaces inherited from interface repicea.simulation.covariateproviders.treelevel.SpeciesTypeProvider

SpeciesTypeProvider.SpeciesType

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABIES
ACER
ALNUS
BETULA
CARPINUS_BETULUS
CASTANEA_SATIVA
FAGUS_SYLVATICA
FRAXINUS
JUGLANS
LARIX_DECIDUA
PICEA_ABIES
PICEA_SITCHENSIS
PINUS_PINASTER
PINUS_RADIATA
PINUS_STROBUS
PINUS_SYLVESTRIS
POPULUS
PRUNUS
PSEUDOTSUGA_MENZIESII
QUERCUS
SALIX
THUJA_PLICATA
TILIA
TSUGA

Method Summary

Modifier and Type	Method and Description
double	getBarkProportionOfWoodVolume() Returns the bark proportion with respect to the wood volume.
double	getBasicWoodDensity() This method returns the basic wood density calculated as the oven dry weight / green volume (e.g.
static CATSettings.CATSpecies	getCATSpeciesFromThisString(java.lang.String speciesName) This method returns the CATSpecies defined by the speciesName parameter.
SpeciesTypeProvider.SpeciesType	getSpeciesType() This method returns the species type of the tree.
java.lang.String	toString()
static CATSettings.CATSpecies	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CATSettings.CATSpecies[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABIES

public static final CATSettings.CATSpecies ABIES

ACER

public static final CATSettings.CATSpecies ACER

ALNUS

public static final CATSettings.CATSpecies ALNUS

BETULA

public static final CATSettings.CATSpecies BETULA

CARPINUS_BETULUS

public static final CATSettings.CATSpecies CARPINUS_BETULUS

CASTANEA_SATIVA

public static final CATSettings.CATSpecies CASTANEA_SATIVA

FAGUS_SYLVATICA

public static final CATSettings.CATSpecies FAGUS_SYLVATICA

FRAXINUS

public static final CATSettings.CATSpecies FRAXINUS

JUGLANS

public static final CATSettings.CATSpecies JUGLANS

LARIX_DECIDUA

public static final CATSettings.CATSpecies LARIX_DECIDUA

PICEA_ABIES

public static final CATSettings.CATSpecies PICEA_ABIES

PICEA_SITCHENSIS

public static final CATSettings.CATSpecies PICEA_SITCHENSIS

PINUS_PINASTER

public static final CATSettings.CATSpecies PINUS_PINASTER

PINUS_RADIATA

public static final CATSettings.CATSpecies PINUS_RADIATA

PINUS_STROBUS

public static final CATSettings.CATSpecies PINUS_STROBUS

PINUS_SYLVESTRIS

public static final CATSettings.CATSpecies PINUS_SYLVESTRIS

POPULUS

public static final CATSettings.CATSpecies POPULUS

PRUNUS

public static final CATSettings.CATSpecies PRUNUS

PSEUDOTSUGA_MENZIESII

public static final CATSettings.CATSpecies PSEUDOTSUGA_MENZIESII

QUERCUS

public static final CATSettings.CATSpecies QUERCUS

SALIX

public static final CATSettings.CATSpecies SALIX

THUJA_PLICATA

public static final CATSettings.CATSpecies THUJA_PLICATA

TILIA

public static final CATSettings.CATSpecies TILIA

TSUGA

public static final CATSettings.CATSpecies TSUGA

Method Detail

values

public static CATSettings.CATSpecies[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CATSettings.CATSpecies c : CATSettings.CATSpecies.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CATSettings.CATSpecies valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<CATSettings.CATSpecies>

getBasicWoodDensity

public double getBasicWoodDensity()

Description copied from interface: BasicWoodDensityProvider

This method returns the basic wood density calculated as the oven dry weight / green volume (e.g. 30% of moisture content).

Specified by:

getBasicWoodDensity in interface BasicWoodDensityProvider

Returns:

the basic wood density (Mg/m3)

getSpeciesType

public SpeciesTypeProvider.SpeciesType getSpeciesType()

Description copied from interface: SpeciesTypeProvider

This method returns the species type of the tree.

Specified by:

getSpeciesType in interface SpeciesTypeProvider

Returns:

a SpeciesType enum

getCATSpeciesFromThisString

public static CATSettings.CATSpecies getCATSpeciesFromThisString(java.lang.String speciesName)

This method returns the CATSpecies defined by the speciesName parameter.

Parameters:

speciesName - a String

Returns:

a CATSpecies instance

getBarkProportionOfWoodVolume

public double getBarkProportionOfWoodVolume()

Description copied from interface: BarkProportionProvider

Returns the bark proportion with respect to the wood volume.

Specified by:

getBarkProportionOfWoodVolume in interface BarkProportionProvider

Returns:

the bark proportion