lerfob.predictor.mathilde

Enum MathildeTreeSpeciesProvider.MathildeTreeSpecies

java.lang.Object

java.lang.Enum<MathildeTreeSpeciesProvider.MathildeTreeSpecies>

lerfob.predictor.mathilde.MathildeTreeSpeciesProvider.MathildeTreeSpecies

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MathildeTreeSpeciesProvider.MathildeTreeSpecies>, REpiceaTranslator.TextableEnum

Enclosing interface:

MathildeTreeSpeciesProvider

public static enum MathildeTreeSpeciesProvider.MathildeTreeSpecies
extends java.lang.Enum<MathildeTreeSpeciesProvider.MathildeTreeSpecies>
implements REpiceaTranslator.TextableEnum

This enum variable defines the different species in the Mathilde simulator.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CARPINUS
FAGUS
OTHERS
QUERCUS

Method Summary

Modifier and Type	Method and Description
Matrix	getLongDummyVariable() This method returns a 1x4 row vector of dummy variables which represent the species effect.
Matrix	getShortDummyVariable() This method returns a 1x3 row vector of dummy variables which represent the species effect.
static MathildeTreeSpeciesProvider.MathildeTreeSpecies	getSpecies(int code) This method returns the species enum according to the code.
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 MathildeTreeSpeciesProvider.MathildeTreeSpecies	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MathildeTreeSpeciesProvider.MathildeTreeSpecies[]	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

CARPINUS

public static final MathildeTreeSpeciesProvider.MathildeTreeSpecies CARPINUS

QUERCUS

public static final MathildeTreeSpeciesProvider.MathildeTreeSpecies QUERCUS

FAGUS

public static final MathildeTreeSpeciesProvider.MathildeTreeSpecies FAGUS

OTHERS

public static final MathildeTreeSpeciesProvider.MathildeTreeSpecies OTHERS

Method Detail

values

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

Returns:

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

valueOf

public static MathildeTreeSpeciesProvider.MathildeTreeSpecies 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

getSpecies

public static MathildeTreeSpeciesProvider.MathildeTreeSpecies getSpecies(int code)

This method returns the species enum according to the code.

Parameters:

code - an integer (17 for Carpinus, 22 for Quercus, 42 for Fagus, and 99 for others)

Returns:

a MathildeTreeSpecies enum

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<MathildeTreeSpeciesProvider.MathildeTreeSpecies>

getShortDummyVariable

public Matrix getShortDummyVariable()

This method returns a 1x3 row vector of dummy variables which represent the species effect.

Returns:

a Matrix instance

getLongDummyVariable

public Matrix getLongDummyVariable()

This method returns a 1x4 row vector of dummy variables which represent the species effect.

Returns:

a Matrix instance