repicea.simulation.species

Enum REpiceaSpecies.Species

java.lang.Object

java.lang.Enum<REpiceaSpecies.Species>

repicea.simulation.species.REpiceaSpecies.Species

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<REpiceaSpecies.Species>, BarkProportionProvider, BasicWoodDensityProvider, SpeciesTypeProvider, REpiceaTranslator.TextableEnum

Enclosing class:

REpiceaSpecies

public static enum REpiceaSpecies.Species
extends java.lang.Enum<REpiceaSpecies.Species>
implements REpiceaTranslator.TextableEnum, SpeciesTypeProvider, BarkProportionProvider, BasicWoodDensityProvider

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_spp
Acer_spp
Alnus_spp
Betula_spp
Carpinus_betulus
Castanea_sativa
Fagus_sylvatica
Fraxinus_spp
Juglans_spp
Larix_decidua
Picea_abies
Picea_sitchensis
Pinus_pinaster
Pinus_radiata
Pinus_strobus
Pinus_sylvestris
Populus_spp
Prunus_spp
Pseudotsuga_menziesii
Quercus_spp
Salix_spp
Thuja_plicata
Tilia_spp
Tsuga_spp

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.
java.lang.String	getLatinName()
SpeciesTypeProvider.SpeciesType	getSpeciesType() This method returns the species type of the tree.
void	setText(java.lang.String englishText, java.lang.String frenchText) This method sets the english and french text for the label, control or title.
java.lang.String	toString()
static REpiceaSpecies.Species	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static REpiceaSpecies.Species[]	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_spp

public static final REpiceaSpecies.Species Abies_spp

Acer_spp

public static final REpiceaSpecies.Species Acer_spp

Alnus_spp

public static final REpiceaSpecies.Species Alnus_spp

Betula_spp

public static final REpiceaSpecies.Species Betula_spp

Carpinus_betulus

public static final REpiceaSpecies.Species Carpinus_betulus

Castanea_sativa

public static final REpiceaSpecies.Species Castanea_sativa

Fagus_sylvatica

public static final REpiceaSpecies.Species Fagus_sylvatica

Fraxinus_spp

public static final REpiceaSpecies.Species Fraxinus_spp

Juglans_spp

public static final REpiceaSpecies.Species Juglans_spp

Larix_decidua

public static final REpiceaSpecies.Species Larix_decidua

Picea_abies

public static final REpiceaSpecies.Species Picea_abies

Picea_sitchensis

public static final REpiceaSpecies.Species Picea_sitchensis

Pinus_pinaster

public static final REpiceaSpecies.Species Pinus_pinaster

Pinus_radiata

public static final REpiceaSpecies.Species Pinus_radiata

Pinus_strobus

public static final REpiceaSpecies.Species Pinus_strobus

Pinus_sylvestris

public static final REpiceaSpecies.Species Pinus_sylvestris

Populus_spp

public static final REpiceaSpecies.Species Populus_spp

Prunus_spp

public static final REpiceaSpecies.Species Prunus_spp

Pseudotsuga_menziesii

public static final REpiceaSpecies.Species Pseudotsuga_menziesii

Quercus_spp

public static final REpiceaSpecies.Species Quercus_spp

Salix_spp

public static final REpiceaSpecies.Species Salix_spp

Thuja_plicata

public static final REpiceaSpecies.Species Thuja_plicata

Tilia_spp

public static final REpiceaSpecies.Species Tilia_spp

Tsuga_spp

public static final REpiceaSpecies.Species Tsuga_spp

Method Detail

values

public static REpiceaSpecies.Species[] 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 (REpiceaSpecies.Species c : REpiceaSpecies.Species.values())
    System.out.println(c);

Returns:

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

valueOf

public static REpiceaSpecies.Species 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

setText

public void setText(java.lang.String englishText,
                    java.lang.String frenchText)

Description copied from interface: REpiceaTranslator.TextableEnum

This method sets the english and french text for the label, control or title.

Specified by:

setText in interface REpiceaTranslator.TextableEnum

Parameters:

englishText - a String

frenchText - a String

getLatinName

public java.lang.String getLatinName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<REpiceaSpecies.Species>

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)

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

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