FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Core::FMTFunctionCall Class Reference

Function call usable in yield or output expressions, such as exponential or natural log. More...

#include <FMTFunctionCall.h>

Public Member Functions

 FMTFunctionCall ()
 Default constructor for FMTFunctionCall.
 
 FMTFunctionCall (const std::string &base)
 Construct a FMTFunctionCall from a string key.
 
double call (const double &rhs) const
 Apply the function to a value.
 
 FMTFunctionCall (const FMTFunctionCall &rhs)
 Copy constructor for FMTFunctionCall.
 
FMTFunctionCalloperator= (const FMTFunctionCall &rhs)
 Copy assignment operator for FMTFunctionCall.
 
bool valid () const
 Return true if the function call is valid.
 
 ~FMTFunctionCall ()=default
 Default destructor for FMTFunctionCall.
 

Detailed Description

Function call usable in yield or output expressions, such as exponential or natural log.

Constructor & Destructor Documentation

◆ FMTFunctionCall() [1/3]

Core::FMTFunctionCall::FMTFunctionCall ( )

Default constructor for FMTFunctionCall.

◆ FMTFunctionCall() [2/3]

Core::FMTFunctionCall::FMTFunctionCall ( const std::string &  base)

Construct a FMTFunctionCall from a string key.

Parameters
[in]basethe string representation of the function.

◆ FMTFunctionCall() [3/3]

Core::FMTFunctionCall::FMTFunctionCall ( const FMTFunctionCall rhs)

Copy constructor for FMTFunctionCall.

Parameters
[in]rhsthe FMTFunctionCall to copy.

◆ ~FMTFunctionCall()

Core::FMTFunctionCall::~FMTFunctionCall ( )
default

Default destructor for FMTFunctionCall.

Member Function Documentation

◆ call()

double Core::FMTFunctionCall::call ( const double &  rhs) const

Apply the function to a value.

Parameters
[in]rhsthe value to apply the function to.
Returns
the result of the function.

◆ operator=()

FMTFunctionCall & Core::FMTFunctionCall::operator= ( const FMTFunctionCall rhs)

Copy assignment operator for FMTFunctionCall.

Parameters
[in]rhsthe FMTFunctionCall to copy.
Returns
a reference to this FMTFunctionCall.

◆ valid()

bool Core::FMTFunctionCall::valid ( ) const

Return true if the function call is valid.

Returns
true if the function is valid else false.

The documentation for this class was generated from the following file: