Exception::FMTError Class Reference

Exception class derived from FMTException for errors thrown in FMT. More...

#include <FMTError.h>

Inherits Exception::FMTException.

Inherited by Exception::FMTBoostGraphError, Exception::FMTCoinError, Exception::FMTDeathWithLock, Exception::FMTEmptyOA, Exception::FMTEmptySchedules, Exception::FMTEmptyTheme, Exception::FMTFunctionFailed, Exception::FMTGDALConstructorError, Exception::FMTGDALError, Exception::FMTInfeasibleConstraint, Exception::FMTInvalidAandT, Exception::FMTInvalidAction, Exception::FMTInvalidAggregate, Exception::FMTInvalidBand, Exception::FMTInvalidConstraint, Exception::FMTInvalidDataset, Exception::FMTInvalidDriver, Exception::FMTInvalidGeometry, Exception::FMTInvalidLayer, Exception::FMTInvalidMaskrange, Exception::FMTInvalidNumber, Exception::FMTInvalidOverview, Exception::FMTInvalidPath, Exception::FMTInvalidRasterBlock, Exception::FMTInvalidTheme, Exception::FMTInvalidTransition, Exception::FMTInvalidTransitionCase, Exception::FMTInvalidYield, Exception::FMTInvalidYieldNumber, Exception::FMTLeakingTransition, Exception::FMTMSKError, Exception::FMTMissingDevelopment, Exception::FMTMissingField, Exception::FMTMissingLicense, Exception::FMTMissingObjective, Exception::FMTMissingParameter, Exception::FMTMissingScenarios, Exception::FMTMissingYield, Exception::FMTNotLineGraph, Exception::FMTOutOfRangeYield, Exception::FMTOutputMissingOperator, Exception::FMTOutputTooMuchOperator, Exception::FMTOveridedYield, Exception::FMTRangeError, Exception::FMTSameTransitionTargets, Exception::FMTSourceToTargetTransition, Exception::FMTThreadCrash, Exception::FMTUnboundedPeriod, Exception::FMTUnclosedForLoop, Exception::FMTUndefinedAction, Exception::FMTUndefinedAttribute, Exception::FMTUndefinedConstant, Exception::FMTUndefinedOutput, Exception::FMTUndefinedOutputAttribute, Exception::FMTUnhandledError, Exception::FMTUnsupportedObjective, Exception::FMTUnsupportedOutput, Exception::FMTUnsupportedYield, Exception::FMTWIN32Error, and Exception::FMTWrongPartial.

Collaboration diagram for Exception::FMTError:

Public Member Functions
	~FMTError ()=default
	Default destructor for FMTError.
FMTError &	operator= (const FMTError &)=default
	Default copy assignment operator for FMTError.
	FMTError ()
	Default constructor for FMTError.
	FMTError (FMTexc p_exception, FMTlev p_level, Core::FMTsection p_section, const std::string &p_message, const std::string &p_method, const std::string &p_file, const int &p_line, const std::string &p_FrenchDescription, const std::string &p_EnglishDescription)
	Construct a FMTError from an exception type, a section, a message and the location where it occurred.
Public Member Functions inherited from Exception::FMTException
	FMTException ()
	Default constructor for FMTException.
virtual	~FMTException ()=default
	Default virtual destructor for FMTException.
	FMTException (FMTexc p_exception, FMTlev p_level, Core::FMTsection p_section, const std::string &p_message, const std::string &p_method, const std::string &p_file, const int &p_line, const std::string &p_FrenchDescription, const std::string &p_EnglishDescription)
	Construct a FMTException from an exception type, a section, a message and the location where it occurred.
	FMTException (const FMTException &rhs)=default
	Default copy constructor for FMTException.
FMTException &	operator= (const FMTException &rhs)=default
	Default copy assignment operator for FMTException.
FMTexc	getType () const
	Return the type of exception held by this FMTException.
Core::FMTsection	getSection () const
	Return the section in which the exception occurred.
const char *	what () const noexcept override
	Override the what function of the base exception class returning the message string.
bool	hold () const
	Return the value of the holdup member.
void	setHold (bool side)
	Set the value of the holdup member.
std::string	getMethod () const
	Return the method in which the exception occurred.
std::string	getFile () const
	Return the source file in which the exception occurred.
int	getLine () const
	Return the source file line in which the exception occurred.
const std::string &	getDescription (bool p_french=false) const
	Return the description of the exception thrown.
std::string	getSrcInfo () const
	Return a formatted string for the location of the exception.
const std::string &	getMessage () const
	Return the message of the exception.
FMTlev	getLevel () const
	Return the level of the exception.
bool	isFatal () const
	return true if it is fatal
void	setIgnore ()
	set a ignore message to the exception and turn the level to warning
void	setPrintLevel (int p_level)
	set the level of print and change the message

Friends
class	boost::serialization::access
	Serialize the FMTError through its base FMTException for multiprocessing across multiple cpus (pickle in Python).

Detailed Description

Exception class derived from FMTException for errors thrown in FMT.

See FMTException for more information about the member data. Any error should be thrown in FMT.

Constructor & Destructor Documentation

~FMTError()

Exception::FMTError::~FMTError ( )

default

Default destructor for FMTError.

FMTError() [1/2]

Exception::FMTError::FMTError

(

)

Default constructor for FMTError.

FMTError() [2/2]

Exception::FMTError::FMTError	(	FMTexc	p_exception,
		FMTlev	p_level,
		Core::FMTsection	p_section,
		const std::string &	p_message,
		const std::string &	p_method,
		const std::string &	p_file,
		const int &	p_line,
		const std::string &	p_FrenchDescription,
		const std::string &	p_EnglishDescription
	)

Construct a FMTError from an exception type, a section, a message and the location where it occurred.

Parameters

[in]	p_exception	the exception type.
[in]	p_level	level of the exception type.
[in]	p_section	the section in which the exception occurred.
[in]	p_message	the message of the exception.
[in]	p_method	the method where the exception occurred.
[in]	p_file	the file where the exception occurred.
[in]	p_line	the line where the exception occurred.
[in]	p_FrenchDescription	french description.
[in]	p_EnglishDescription	english description.

Member Function Documentation

operator=()

FMTError & Exception::FMTError::operator= ( const FMTError &  )

default

Default copy assignment operator for FMTError.

Returns

a reference to this FMTError.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Serialize the FMTError through its base FMTException for multiprocessing across multiple cpus (pickle in Python).

Template Parameters

Archive

the archive type.

Parameters

[in,out]	ar	the archive to serialize to or from.
[in]	version	the serialization version.

---

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

• D:/FMT/Include/FMTError.h