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

#include <FMTwarning.hpp>

Inheritance diagram for Exception::FMTwarning:
[legend]
Collaboration diagram for Exception::FMTwarning:
[legend]

Public Member Functions

 ~FMTwarning ()=default
 
FMTwarningoperator= (const FMTwarning &)=default
 
 FMTwarning ()
 
 FMTwarning (const FMTexception &rhs)
 
 FMTwarning (const FMTexc lexception, const std::string message)
 
 FMTwarning (const FMTexc lexception, const Core::FMTsection lsection, const std::string message)
 
 FMTwarning (const FMTexc lexception, const Core::FMTsection lsection, const std::string message, const std::string &lmethod, const std::string &lfile, const int &lline)
 
void warn (const std::shared_ptr< Logging::FMTlogger >logger, std::unordered_map< int, size_t > &specificwarningcount, const size_t &maxwarning) const
 
- Public Member Functions inherited from Exception::FMTexception
 FMTexception ()
 
virtual ~FMTexception ()=default
 
 FMTexception (const std::exception &baseexception)
 
 FMTexception (const FMTexc lexception, const std::string message)
 
 FMTexception (const FMTexc lexception, Core::FMTsection lsection, const std::string message)
 
 FMTexception (const FMTexc lexception, Core::FMTsection lsection, const std::string message, const std::string &lmethod, const std::string &lfile, const int &lline)
 
 FMTexception (const FMTexc lexception, Core::FMTsection lsection, const std::string message, const std::string &lmethod)
 
 FMTexception (const FMTexc lexception, const std::string message, const std::string &lmethod, const std::string &lfile, const int &lline)
 
 FMTexception (const FMTexc lexception, const std::string message, const std::string &lmethod)
 
 FMTexception (const FMTexception &rhs)
 
FMTexceptionoperator= (const FMTexception &rhs)
 
FMTexc gettype () const
 
Core::FMTsection getsection () const
 
const char * what () const override throw ()
 
bool hold () const
 
void sethold (bool side)
 
std::string getmethod () const
 
std::string getfile () const
 
int getline () const
 
std::string getsrcinfo () const
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Attributes inherited from Exception::FMTexception
bool holdup
 
std::string _msg
 Keeps the message string of the exception.
 
FMTexc exceptiontype
 Type of the exception thrown.
 
Core::FMTsection section
 Section in which the exception just happened.
 
std::string method
 Function where the exception just happened.
 
std::string file
 Source file where the exception just happened.
 
int line
 Source file line where the exception just happened.
 

Detailed Description

FMTwarning is derived from the FMTexception base class. See FMTexception class for more information about the member data. In FMT warning are never thrown but only logged depending of the FMTlogger and FMTexceptionhandler used.

Constructor & Destructor Documentation

◆ ~FMTwarning()

Exception::FMTwarning::~FMTwarning ( )
default

Default destructor for FMTwarning.

◆ FMTwarning() [1/5]

Exception::FMTwarning::FMTwarning ( )

Default constructor for FMTwarning.

◆ FMTwarning() [2/5]

Exception::FMTwarning::FMTwarning ( const FMTexception rhs)

Default copy constructor for FMTwarning.

◆ FMTwarning() [3/5]

Exception::FMTwarning::FMTwarning ( const FMTexc  lexception,
const std::string  message 
)

Constructor for FMTwarning taking a exception type and message string as arguments.

◆ FMTwarning() [4/5]

Exception::FMTwarning::FMTwarning ( const FMTexc  lexception,
const Core::FMTsection  lsection,
const std::string  message 
)

Constructor for FMTwarning taking a exception type, section in which the warning occur and message string as arguments.

◆ FMTwarning() [5/5]

Exception::FMTwarning::FMTwarning ( const FMTexc  lexception,
const Core::FMTsection  lsection,
const std::string  message,
const std::string &  lmethod,
const std::string &  lfile,
const int &  lline 
)

Constructor for FMTwarning taking a exception type, section in which the warning occur and message string as arguments and the location where the exception occured (method/file/line).

Member Function Documentation

◆ operator=()

FMTwarning & Exception::FMTwarning::operator= ( const FMTwarning )
default

Default copy assignment for FMTwarning.

◆ warn()

void Exception::FMTwarning::warn ( const std::shared_ptr< Logging::FMTlogger logger,
std::unordered_map< int, size_t > &  specificwarningcount,
const size_t &  maxwarning 
) const

Using a given logger the function log the warning with the logger.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Serialize function is for serialization, used to do multiprocessing across multiple cpus (pickle in Pyhton)


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