Core Namespace Reference

The Core namespace provides classes for simulating stands/strata growth/harvest through time. More...

Classes
struct	cmpYieldString
	Comparator ordering yield names by length then by content from the end. More...
class	FMTAction
	List of specifications dictating the operability of a subset of developments to this action. More...
class	FMTActionComparator
	Comparator used to check if an action name (or aggregate) already exists in a std container. More...
class	FMTActualDevelopment
	Child class of FMTDevelopment representing an actual forest stand, holding the area of the stand. More...
class	FMTActualDevelopmentComparator
	Comparator used to check if a base development is the actual development. More...
class	FMTAgeYieldHandler
	Yield handler for age based yields, as seen in the yield section with _AGE. More...
class	FMTBounds
class	FMTComplexYieldHandler
	Yield handler for complex yields computed from other yields using operators, as seen in the yield section. More...
class	FMTConstants
	Class holding the constants defined in the constants section of a model, used by the parsers. More...
class	FMTConstraint
	Representation of a line in the optimize section, an objective being considered a constraint. More...
class	FMTData
	Data of a yield holding the values, sources and operators used to compute complex yields. More...
class	FMTDevelopment
	Base class of FMTActualDevelopment and FMTFuturDevelopment representing a forest stand. More...
class	FMTDevelopmentPath
	Development path holding a generated development and the proportion of area going to it. More...
class	FMTExpression
	Mathematical expression evaluated with the shunting yard algorithm, used in yields and outputs. More...
class	FMTFork
	Fork of a transition, holding the transition masks (targets and proportions) applied to a development when an action is operated. More...
class	FMTFunctionCall
	Function call usable in yield or output expressions, such as exponential or natural log. More...
class	FMTFuturDevelopment
	Child class of FMTDevelopment representing a future stand generated by growth or transition, not existing in the actual forest. More...
class	FMTGCBMTransition
	Simple container for a GCBM transition, only useful when working with GCBM. More...
class	FMTLifespans
	List holding the maximum age of aggregates of developments. More...
class	FMTList
class	FMTLookup
	Lookup helper holding an in-memory object and a pointer to a keyed object, used for hashing and comparison. More...
class	FMTMask
	Core class holding, as a boost dynamic bitset, which theme attributes are part of a mask. More...
class	FMTMaskComparator
	Comparator used to check if a mask already exists in a std container. More...
class	FMTMaskFilter
	Filter built from masks used to preSolve and postsolve FMTMask objects. More...
class	FMTModelYieldHandler
	Yield handler wrapping machine learning yield models. More...
class	FMTObject
	Base class of multiple FMT classes holding a shared exception handler pointer and logger. More...
class	FMTOperator
	Mathematical operator usable in yield and output expressions. More...
class	FMTOutput
	Class letting the user formulate a constraint in the optimize section or collect data across the graph. More...
class	FMTOutputComparator
	Comparator used to check if an output name already exists in a std container. More...
class	FMTOutputNode
	Node of an output representing a set of developments in the graph, holding a source, a factor and a constant. More...
class	FMTOutputNodeHasher
	Hasher for output nodes. More...
class	FMTOutputNodeOriginComparator
	Comparator comparing output nodes by origin. More...
class	FMTOutputNodeValueComparator
	Comparator comparing output nodes by value. More...
class	FMTOutputSource
	Source of an output holding a mask, a target and values, used to compute an output. More...
class	FMTOutputSourceComparator
	Comparator used to match output sources by whether they are variable. More...
class	FMTSchedule
	Spatially referenced schedule describing the area of developments for which an action can be operated, usable by FMTLpModel and FMTSesModel. More...
class	FMTSerie
	Class keeping the information of a serie of actions in a given order. More...
class	FMTTheme
	Class holding the attributes and aggregates of a single theme, describing a part of a FMTMask. More...
class	FMTThemeComparator
	Comparator used to check if two themes are the same. More...
class	FMTTimeYieldHandler
	Yield handler for time based yields, indexed by period. More...
class	FMTTransition
	List of FMTFork describing the transition of an action, disturbing a development to generate new development paths. More...
class	FMTTransitionComparator
	Comparator used to compare FMTTransition with std::find_if when transitions are in a std container. More...
class	FMTTransitionMask
	Transition mask holding a target mask and a proportion, used to disturb a development in a transition. More...
class	FMTYieldDevelopment
	Development keyed by age, period, mask and yield, used to cache yield values. More...
class	FMTYieldHandler
	Base class for yield handlers, holding a mask and the base ages of the yields. More...
class	FMTYieldModel
	Abstract class to be implemented as a machine learning yield model. More...
class	FMTYieldModelDecisionTree
	Yield model using a decision tree based on the growth outputs of the model to get yield values. More...
class	FMTYieldModelNep
	Machine learning yield model predicting carbon NEP. More...
class	FMTYieldModelNn
	Abstract machine learning yield model based on a neural network. More...
class	FMTYieldModelPools
	Machine learning yield model predicting carbon pools. More...
class	FMTYieldModelRandom
class	FMTYieldModelTsla
	Yield model returning the time since last disturbance, always added by default by the yield parser. More...
class	FMTYieldModelUnitCoverage
	Yield model calculating the sum of a yield value over a spatial unit at period 0. More...
class	FMTYieldRequest
	Request for yield values using a development and optionally a graph vertex. More...
class	FMTYields
	FMTList containing multiple yield handlers as seen in the yield section, holding the information related to forest productivity. More...
class	FMTYieldsCache
	Cache of yield values keyed by development and yield name. More...

Enumerations
enum	FMTconstrainttype {   FMTMAXobjective = 1 , FMTMINobjective = 2 , FMTMAXMINobjective = 3 , FMTMINMAXobjective = 4 ,   FMTevenflow = 5 , FMTnondeclining = 6 , FMTsequence = 7 , FMTstandard = 8 ,   FMTspatialsize = 9 , FMTspatialadjacency = 10 , FMTspatialgreenup = 11 , FMTSpatialGroup = 12 ,   FMTrandomaction = 13 }
	Enumerator of the constraint and objective types found in an optimization section, including spatial constraints for the SA model. More...
enum class	FMTfkey { expo = 1 , ln = 2 , notvalid = 3 }
	Enumerator of the functions usable in an FMTFunctionCall (exponential, natural log). More...
enum class	FMTokey {   multiply = 1 , divide = 2 , add = 3 , sub = 4 ,   comma = 5 , pow = 6 , notvalid = 7 }
	Enumerator of the operators usable in an FMTOperator (multiply, divide, add, sub, comma, pow). More...
enum	FMToutputlevel { standard = 1 , totalonly = 2 , developpement = 3 }
	Enumerator describing the level of detail of an output (standard, total only, development). More...
enum	FMTsection {   Control = 1 , Landscape =2 , Area =3 , Action = 4 ,   Transition =5 , Yield = 6 , Outputs = 7 , Optimize =8 ,   Constants = 9 , Schedule = 10 , Lifespan = 11 , Empty =12 }
	Enumerator describing the sections of a Woodstock model. More...
enum class	FMTkwor { Source =1 , Target =2 }
	Enumerator describing the source or target keyword of a transition. More...
enum	FMTyldtype { FMTageyld = 1 , FMTtimeyld = 2 , FMTcomplexyld = 3 , FMTmodelyld = 4 }
	Enumerator describing the type of a yield (age, time, complex, model). More...
enum class	FMTyieldparserop {   FMTnone = 0 , FMTrange = 1 , FMTmultiply = 2 , FMTsum = 3 ,   FMTsubstract = 4 , FMTytp = 5 , FMTmai = 6 , FMTcai = 7 ,   FMTdivide = 8 , FMTequation = 9 , FMTendpoint = 10 , FMTdiscountfactor = 11 ,   FMTdelta = 12 , FMTmodelpred = 13 , FMTdistance = 14 , FMTmax = 15 ,   FMTmin = 16 , FMTShift = 17 , COUNT = 18 }
	Enumerator describing the operators usable in the yield section. More...
enum	FMTotar {   inventory = 1 , actual = 2 , val = 3 , timeyld = 4 ,   level = 5 }
	Enumerator describing the target of an output (inventory, actual, value, time yield, level). More...

Functions
template<>
void	FMTMask::binarizedAppend< std::string > (const std::string &element)
const char *	FMTsection_str (FMTsection section)
	Return the string representation of a section.

Detailed Description

The Core namespace provides classes for simulating stands/strata growth/harvest through time.

Yield model generating a random index from a discrete distribution using discrete probabilities.

The syntax in the yield section looks like: yrandom _PRED(RANDOM,y1,y2,y3,y4).

Enumeration Type Documentation

FMTconstrainttype

enum Core::FMTconstrainttype

Enumerator of the constraint and objective types found in an optimization section, including spatial constraints for the SA model.

Enumerator
FMTMAXobjective
FMTMINobjective
FMTMAXMINobjective
FMTMINMAXobjective
FMTevenflow
FMTnondeclining
FMTsequence
FMTstandard
FMTspatialsize	Regular constraint m_type like output = 1...
FMTspatialadjacency
FMTspatialgreenup
FMTSpatialGroup
FMTrandomaction

FMTfkey

enum class Core::FMTfkey

strong

Enumerator of the functions usable in an FMTFunctionCall (exponential, natural log).

Enumerator
expo
ln
notvalid

FMTkwor

enum class Core::FMTkwor

strong

Enumerator describing the source or target keyword of a transition.

Enumerator
Source
Target

FMTokey

enum class Core::FMTokey

strong

Enumerator of the operators usable in an FMTOperator (multiply, divide, add, sub, comma, pow).

Enumerator
multiply
divide
add
sub
comma
pow
notvalid

FMTotar

enum Core::FMTotar

Enumerator describing the target of an output (inventory, actual, value, time yield, level).

Enumerator
inventory
actual
val
timeyld
level

FMToutputlevel

enum Core::FMToutputlevel

Enumerator describing the level of detail of an output (standard, total only, development).

Enumerator
standard
totalonly
developpement

FMTsection

enum Core::FMTsection

Enumerator describing the sections of a Woodstock model.

Enumerator
Control
Landscape
Area
Action
Transition
Yield
Outputs
Optimize
Constants
Schedule
Lifespan
Empty

FMTyieldparserop

enum class Core::FMTyieldparserop

strong

Enumerator describing the operators usable in the yield section.

Enumerator
FMTnone
FMTrange
FMTmultiply
FMTsum
FMTsubstract
FMTytp
FMTmai
FMTcai
FMTdivide
FMTequation
FMTendpoint
FMTdiscountfactor
FMTdelta
FMTmodelpred
FMTdistance
FMTmax
FMTmin
FMTShift
COUNT

FMTyldtype

enum Core::FMTyldtype

Enumerator describing the type of a yield (age, time, complex, model).

Enumerator
FMTageyld
FMTtimeyld
FMTcomplexyld
FMTmodelyld

Function Documentation

FMTMask::binarizedAppend< std::string >()

template<>

void Core::FMTMask::binarizedAppend< std::string > ( const std::string &  element )

inline

FMTsection_str()

const char * Core::FMTsection_str

(

FMTsection

section

)

Return the string representation of a section.

Parameters

[in]

section

the section.

Returns

the string representation of the section.