FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
FMTFunctionCall.h
Go to the documentation of this file.
1/*
2Copyright (c) 2019 Gouvernement du Québec
3
4SPDX-License-Identifier: LiLiQ-R-1.1
5License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
6*/
7
8#ifndef FMTfunctioncall_Hm_included
9#define FMTfunctioncall_Hm_included
10
11#include <string>
12
13
14
15namespace Core
16{
17 // DocString: FMTfkey
21 enum class FMTfkey
22 {
23 expo = 1,
24 ln = 2,
25 notvalid = 3
26 };
27
28 // DocString: FMTFunctionCall
33 {
34 public:
35 // DocString: FMTFunctionCall()
40 // DocString: FMTFunctionCall(const std::string&)
45 FMTFunctionCall(const std::string& base);
46 // DocString: FMTFunctionCall::call
52 double call(const double& rhs) const;
53 // DocString: FMTFunctionCall(const FMTFunctionCall&)
59 // DocString: FMTFunctionCall::operator=
66 // DocString: FMTFunctionCall::valid
71 bool valid() const;
72 // DocString: ~FMTFunctionCall()
76 ~FMTFunctionCall() = default;
77 private:
78 FMTfkey m_key;
79 };
80}
81
82#endif
Function call usable in yield or output expressions, such as exponential or natural log.
Definition: FMTFunctionCall.h:33
~FMTFunctionCall()=default
Default destructor for FMTFunctionCall.
FMTFunctionCall(const std::string &base)
Construct a FMTFunctionCall from a string key.
bool valid() const
Return true if the function call is valid.
double call(const double &rhs) const
Apply the function to a value.
FMTFunctionCall & operator=(const FMTFunctionCall &rhs)
Copy assignment operator for FMTFunctionCall.
FMTFunctionCall()
Default constructor for FMTFunctionCall.
FMTFunctionCall(const FMTFunctionCall &rhs)
Copy constructor for FMTFunctionCall.
The Core namespace provides classes for simulating stands/strata growth/harvest through time.
Definition: FMTAction.h:34
FMTfkey
Enumerator of the functions usable in an FMTFunctionCall (exponential, natural log).
Definition: FMTFunctionCall.h:22