awsmodel
Enum AWSTreatment.TreatmentVariable

java.lang.Object
  extended by java.lang.Enum<AWSTreatment.TreatmentVariable>
      extended by awsmodel.AWSTreatment.TreatmentVariable
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AWSTreatment.TreatmentVariable>
Enclosing interface:
AWSTreatment

public static enum AWSTreatment.TreatmentVariable
extends java.lang.Enum<AWSTreatment.TreatmentVariable>

This Enum variable defines all the treatment-related variables required by this model.

Author:
M. Fortin and A. Albrecht - August 2010

Enum Constant Summary
cumulatedRemovals
          The cumulative merchantable volume of all thinnings to date as a ratio of total volume production (current volume + all thinnings to date)
nbYrsSincePreviousIntervention
          The number of years since the last thinning
relativeRemovedVolume
          The ratio between removed volume and volume prior to thinning (values between 0 to 1)
relativeRemovedVolumeInPast10Yrs
          The average ratio between removed volume and volume prior to thinning within the past 10 years.
relativeRemovedVolumeOfPreviousIntervention
          The ratio between removed volume and volume prior to the last thinning (values between 0 to 1), which is on average 5 years (3-7 yrs) before the current date
thinningQuotient
          The ratio between mean quadratic diameter (mqd) of the removed trees and mqd of the stand prior to thinning
thinningQuotientOfPast10Yrs
          The average ratio between mean quadratic diameter (mqd) of the removed trees and mqd of the stand prior to thinning within the past 10 years
 
Method Summary
 java.lang.Object cast(java.lang.Object obj)
           
static AWSTreatment.TreatmentVariable valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AWSTreatment.TreatmentVariable[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

cumulatedRemovals

public static final AWSTreatment.TreatmentVariable cumulatedRemovals
The cumulative merchantable volume of all thinnings to date as a ratio of total volume production (current volume + all thinnings to date)


relativeRemovedVolume

public static final AWSTreatment.TreatmentVariable relativeRemovedVolume
The ratio between removed volume and volume prior to thinning (values between 0 to 1)


thinningQuotient

public static final AWSTreatment.TreatmentVariable thinningQuotient
The ratio between mean quadratic diameter (mqd) of the removed trees and mqd of the stand prior to thinning


relativeRemovedVolumeOfPreviousIntervention

public static final AWSTreatment.TreatmentVariable relativeRemovedVolumeOfPreviousIntervention
The ratio between removed volume and volume prior to the last thinning (values between 0 to 1), which is on average 5 years (3-7 yrs) before the current date


nbYrsSincePreviousIntervention

public static final AWSTreatment.TreatmentVariable nbYrsSincePreviousIntervention
The number of years since the last thinning


relativeRemovedVolumeInPast10Yrs

public static final AWSTreatment.TreatmentVariable relativeRemovedVolumeInPast10Yrs
The average ratio between removed volume and volume prior to thinning within the past 10 years.


thinningQuotientOfPast10Yrs

public static final AWSTreatment.TreatmentVariable thinningQuotientOfPast10Yrs
The average ratio between mean quadratic diameter (mqd) of the removed trees and mqd of the stand prior to thinning within the past 10 years

Method Detail

values

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

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

valueOf

public static AWSTreatment.TreatmentVariable 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

cast

public java.lang.Object cast(java.lang.Object obj)
                      throws java.lang.Exception
Throws:
java.lang.Exception