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

Development keyed by age, period, mask and yield, used to cache yield values. More...

#include <FMTYieldDevelopment.h>

Public Member Functions

 FMTYieldDevelopment (int p_age, int p_period, const boost::dynamic_bitset< uint8_t > &p_mask, const std::string &p_yield)
 Construct a yield development from an age, a period, a mask and a yield.
 
bool operator== (const FMTYieldDevelopment &p_yieldDev) const
 Equality comparison operator of FMTYieldDevelopment.
 
size_t hash () const
 Return the hash of the yield development.
 
int getPeriod () const
 Return the period of the yield development.
 

Detailed Description

Development keyed by age, period, mask and yield, used to cache yield values.

Constructor & Destructor Documentation

◆ FMTYieldDevelopment()

Core::FMTYieldDevelopment::FMTYieldDevelopment ( int  p_age,
int  p_period,
const boost::dynamic_bitset< uint8_t > &  p_mask,
const std::string &  p_yield 
)

Construct a yield development from an age, a period, a mask and a yield.

Parameters
[in]p_agethe age.
[in]p_periodthe period.
[in]p_maskthe mask.
[in]p_yieldthe yield.

Member Function Documentation

◆ getPeriod()

int Core::FMTYieldDevelopment::getPeriod ( ) const

Return the period of the yield development.

Returns
the period.

◆ hash()

size_t Core::FMTYieldDevelopment::hash ( ) const

Return the hash of the yield development.

Returns
the hash value.

◆ operator==()

bool Core::FMTYieldDevelopment::operator== ( const FMTYieldDevelopment p_yieldDev) const

Equality comparison operator of FMTYieldDevelopment.

Parameters
[in]p_yieldDevthe yield development to compare with.
Returns
true if both are equal else false.

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