Exception::FMTexception Class Reference

#include <FMTexception.hpp>

Inheritance diagram for Exception::FMTexception:

Collaboration diagram for Exception::FMTexception:

Public Member Functions
	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)
FMTexception &	operator= (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

Protected Attributes
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.

Friends
class	boost::serialization::access

Detailed Description

FMTexception is the exception base class for FMT. All the informations regarding a given exception is kept by this class (type,section and message).

Constructor & Destructor Documentation

FMTexception() [1/9]

Exception::FMTexception::FMTexception

(

)

FMTexception default constructor.

~FMTexception()

virtual Exception::FMTexception::~FMTexception ( )

virtualdefault

FMTexception default virtual destructor.

FMTexception() [2/9]

Exception::FMTexception::FMTexception

(

const std::exception &

baseexception

)

FMTexception with std exception

FMTexception() [3/9]

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

FMTexception constructor taking a exception type and a message.

FMTexception() [4/9]

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

FMTexception constructor taking a exception type a section and a message.

FMTexception() [5/9]

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

FMTexception constructor taking a exception type a section and a message, the method, file and line where the exception juste happened.

FMTexception() [6/9]

Exception::FMTexception::FMTexception	(	const FMTexc	lexception,
		Core::FMTsection	lsection,
		const std::string	message,
		const std::string &	lmethod
	)

FMTexception constructor taking a exception type a section and a message, the method where the exception juste happened.

FMTexception() [7/9]

Exception::FMTexception::FMTexception	(	const FMTexc	lexception,
		const std::string	message,
		const std::string &	lmethod,
		const std::string &	lfile,
		const int &	lline
	)

FMTexception constructor taking a exception type and a message.

FMTexception() [8/9]

Exception::FMTexception::FMTexception	(	const FMTexc	lexception,
		const std::string	message,
		const std::string &	lmethod
	)

FMTexception constructor taking a exception type and a message and method.

FMTexception() [9/9]

Exception::FMTexception::FMTexception

(

const FMTexception &

rhs

)

FMTexception default copy constructor.

Member Function Documentation

getfile()

std::string Exception::FMTexception::getfile ( ) const

inline

Returns the source file in which the exception occured.

getline()

int Exception::FMTexception::getline ( ) const

inline

Returns the source file line in which the exception occured.

getmethod()

std::string Exception::FMTexception::getmethod ( ) const

inline

Returns the method in which the exception occured.

getsection()

Core::FMTsection Exception::FMTexception::getsection

(

)

const

The function returns the section in which the exception occured.

getsrcinfo()

std::string Exception::FMTexception::getsrcinfo

(

)

const

Returns a formated string for the location of the exception.

gettype()

FMTexc Exception::FMTexception::gettype

(

)

const

The function returns the type of exception kept by this FMTexception.

hold()

bool Exception::FMTexception::hold

(

)

const

Returns the value of the holdup member.

operator=()

FMTexception & Exception::FMTexception::operator=

(

const FMTexception &

rhs

)

FMTexception default copy assignment operator.

sethold()

void Exception::FMTexception::sethold

(

bool

side

)

The function sets the value of holdup member.

what()

const char * Exception::FMTexception::what ( ) const throw ( )

override

This function override the what function of the exception base class returning the message string.

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)

Member Data Documentation

_msg

std::string Exception::FMTexception::_msg

protected

Keeps the message string of the exception.

exceptiontype

FMTexc Exception::FMTexception::exceptiontype

protected

Type of the exception thrown.

file

std::string Exception::FMTexception::file

protected

Source file where the exception just happened.

holdup

bool Exception::FMTexception::holdup

protected

This member is normaly set to false but for the free exception handler we want to let the exception percolate to boost::python and let the user handel the exception when holdup=true.

line

int Exception::FMTexception::line

protected

Source file line where the exception just happened.

method

std::string Exception::FMTexception::method

protected

Function where the exception just happened.

section

Core::FMTsection Exception::FMTexception::section

protected

Section in which the exception just happened.

---

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

• D:/FMT/Include/FMTexception.hpp