FMT 0.9.8
Forest management tools for forest planning
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
Models::FMTmodelparameters Class Reference

#include <FMTmodelparameters.hpp>

Inheritance diagram for Models::FMTmodelparameters:
[legend]
Collaboration diagram for Models::FMTmodelparameters:
[legend]

Public Member Functions

 FMTmodelparameters ()
 
 FMTmodelparameters (const FMTmodelparameters &rhs)
 
FMTmodelparametersoperator= (const FMTmodelparameters &rhs)
 
 ~FMTmodelparameters ()=default
 
 FMTmodelparameters (FMTmodelparameters &&rhs)=default
 
FMTmodelparametersoperator= (FMTmodelparameters &&rhs)=default
 
bool setintparameter (const FMTintmodelparameters &key, const int &value)
 
bool setdblparameter (const FMTdblmodelparameters &key, const double &value)
 
bool setboolparameter (const FMTboolmodelparameters &key, const bool &value)
 
bool setperiodcompresstime (const int &period, const int &value)
 
int getintparameter (const FMTintmodelparameters &key) const
 
double getdblparameter (const FMTdblmodelparameters &key) const
 
bool getboolparameter (const FMTboolmodelparameters &key) const
 
int getperiodcompresstime (const int &period) const
 
std::vector< int > getcompresstime () const
 
- Public Member Functions inherited from Core::FMTobject
 FMTobject ()
 
virtual ~FMTobject ()
 
 FMTobject (const std::shared_ptr< Exception::FMTexceptionhandler > exhandler)
 
 FMTobject (const FMTobject &rhs)
 
FMTobjectoperator= (const FMTobject &rhs)
 
virtual void passinlogger (const std::shared_ptr< Logging::FMTlogger > &logger)
 
void passinexceptionhandler (const std::shared_ptr< Exception::FMTexceptionhandler > &exhandler)
 
void redirectlogtofile (const std::string &location)
 
virtual void setdefaultlogger ()
 
virtual void setquietlogger ()
 
virtual void settasklogger ()
 
virtual void setdebuglogger ()
 
void setdefaultexceptionhandler ()
 
void setquietexceptionhandler ()
 
void setdebugexceptionhandler ()
 
void setfreeexceptionhandler ()
 
void disablenestedexceptions ()
 
void enablenestedexceptions ()
 
void seterrorstowarnings (const std::vector< Exception::FMTexc > &errors)
 
void setmaxwarningsbeforesilenced (const size_t &maxwarningcount)
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Static Public Member Functions inherited from Core::FMTobject
static std::string getruntimelocation ()
 
static unsigned long long getavailablememory ()
 
- Protected Member Functions inherited from Core::FMTobject
template<class Archive >
void forcesave (Archive &ar, const unsigned int version) const
 
template<class Archive >
void forceload (Archive &ar, const unsigned int version)
 
void checksignals () const
 
void setCPLhandler ()
 
- Static Protected Member Functions inherited from Core::FMTobject
static std::chrono::time_point< std::chrono::high_resolution_clock > getclock ()
 
template<class chrono >
static double getduration (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
 
static std::string getdurationinseconds (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
 
- Static Protected Attributes inherited from Core::FMTobject
static std::shared_ptr< Exception::FMTexceptionhandler_exhandler
 A shared pointer to the exception handler.
 
static std::shared_ptr< Logging::FMTlogger_logger
 A shared pointer to the logger.
 

Detailed Description

FMTmodelparameters is a class which contains all the informations a model need to be solve by the different types of FMTmodel. Default int parameters are : LENGTH = 30 SEED = 25 NUMBER_OF_ITERATIONS = 10000 PRESOLVE_ITERATIONS = 10 NUMBER_OF_THREADS = 4 Default double parameters are : TOLERANCE = FMT_DBL_TOLERANCE GOALING_SCHEDULE_WEIGHT = 10000 Default bool parameters are : FORCE_PARTIAL_BUILD = false STRICTLY_POSITIVE = true POSTSOLVE = true SHOW_LOCK_IN_SCHEDULES = false

Constructor & Destructor Documentation

◆ FMTmodelparameters() [1/3]

Models::FMTmodelparameters::FMTmodelparameters ( )

Default constructor

◆ FMTmodelparameters() [2/3]

Models::FMTmodelparameters::FMTmodelparameters ( const FMTmodelparameters rhs)

Copy constructor

◆ ~FMTmodelparameters()

Models::FMTmodelparameters::~FMTmodelparameters ( )
default

Default desctructor of FMTmodelparameters.

◆ FMTmodelparameters() [3/3]

Models::FMTmodelparameters::FMTmodelparameters ( FMTmodelparameters &&  rhs)
default

Default move constructor for FMTmodelparameters.

Member Function Documentation

◆ getboolparameter()

bool Models::FMTmodelparameters::getboolparameter ( const FMTboolmodelparameters key) const

◆ getcompresstime()

std::vector< int > Models::FMTmodelparameters::getcompresstime ( ) const

◆ getdblparameter()

double Models::FMTmodelparameters::getdblparameter ( const FMTdblmodelparameters key) const

◆ getintparameter()

int Models::FMTmodelparameters::getintparameter ( const FMTintmodelparameters key) const

◆ getperiodcompresstime()

int Models::FMTmodelparameters::getperiodcompresstime ( const int &  period) const

◆ operator=() [1/2]

FMTmodelparameters & Models::FMTmodelparameters::operator= ( const FMTmodelparameters rhs)

Copy assignment

◆ operator=() [2/2]

FMTmodelparameters & Models::FMTmodelparameters::operator= ( FMTmodelparameters &&  rhs)
default

Default move assignment for FMTmodelparameters.

◆ setboolparameter()

bool Models::FMTmodelparameters::setboolparameter ( const FMTboolmodelparameters key,
const bool &  value 
)

◆ setdblparameter()

bool Models::FMTmodelparameters::setdblparameter ( const FMTdblmodelparameters key,
const double &  value 
)

◆ setintparameter()

bool Models::FMTmodelparameters::setintparameter ( const FMTintmodelparameters key,
const int &  value 
)

◆ setperiodcompresstime()

bool Models::FMTmodelparameters::setperiodcompresstime ( const int &  period,
const int &  value 
)

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

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