Base::FileException Class Reference

File exception handling class This class is specialized to go with exception thrown in case of File IO Problems. More...

#include <Exception.h>

Public Member Functions
	FileException ()
	standard construction More...
	FileException (const char *sMessage, const char *sFileName=nullptr)
	With massage and file name. More...
	FileException (const char *sMessage, const FileInfo &File)
	With massage and file name. More...
	FileException (const FileException &inst)
	Construction. More...
std::string	getFileName () const
	Get file name for use with translatable message. More...
PyObject *	getPyExceptionType () const override
	returns the corresponding python exception type More...
PyObject *	getPyObject () override
	returns a Python dictionary containing the exception data More...
FileException &	operator= (const FileException &inst)
	Assignment operator. More...
void	ReportException () const override
	Report generation. More...
void	setPyObject (PyObject *pydict) override
	returns sets the exception data from a Python dictionary More...
const char *	what () const override throw ()
	Description of the exception. More...
virtual	~FileException () throw ()
	Destruction. More...
Public Member Functions inherited from Base::Exception
std::string	getFile () const
std::string	getFunction () const
int	getLine () const
std::string	getMessage () const
virtual PyObject *	getPyExceptionType () const
	returns the corresponding python exception type More...
virtual PyObject *	getPyObject ()
	returns a Python dictionary containing the exception data More...
bool	getReported () const
bool	getTranslatable () const
virtual Base::Type	getTypeId (void) const
Exception &	operator= (const Exception &inst)
virtual void	ReportException () const
	Reports exception. It includes a mechanism to only report an exception once. More...
void	setDebugInformation (const std::string &file, const int line, const std::string &function)
	setter methods for including debug information intended to use via macro for autofilling of debugging information More...
void	setMessage (const char *sMessage)
void	setMessage (const std::string &sMessage)
virtual void	setPyException () const
	Sets the Python error indicator and an error message. More...
virtual void	setPyObject (PyObject *pydict)
	returns sets the exception data from a Python dictionary More...
void	setReported (bool reported)
void	setTranslatable (bool translatable)
virtual const char *	what () const throw ()
virtual	~Exception () throw ()
Public Member Functions inherited from Base::BaseClass
	BaseClass ()
	Construction. More...
	BaseClass (const BaseClass &)=default
virtual PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object. More...
virtual Type	getTypeId () const
bool	isDerivedFrom (const Type type) const
BaseClass &	operator= (const BaseClass &)=default
virtual void	setPyObject (PyObject *)
virtual	~BaseClass ()
	Destruction. More...

Protected Member Functions
void	setFileName (const char *sFileName=nullptr)
Protected Member Functions inherited from Base::Exception
	Exception ()
	Exception (const char *sMessage)
	Exception (const Exception &inst)
	Exception (const std::string &sMessage)

Protected Attributes
FileInfo	file

Additional Inherited Members
Static Public Member Functions inherited from Base::Exception
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)
Static Public Member Functions inherited from Base::BaseClass
static void *	create ()
static Type	getClassTypeId ()
static void	init ()
Static Protected Member Functions inherited from Base::BaseClass
static void	initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)

Detailed Description

File exception handling class This class is specialized to go with exception thrown in case of File IO Problems.

Author

Juergen Riegel

Constructor & Destructor Documentation

FileException() [1/4]

FileException::FileException	(	const char *	sMessage,
		const char *	sFileName = nullptr
	)

With massage and file name.

References setFileName().

FileException() [2/4]

FileException::FileException	(	const char *	sMessage,
		const FileInfo &	File
	)

With massage and file name.

References Base::FileInfo::filePath(), and setFileName().

FileException() [3/4]

FileException::FileException

(

)

standard construction

FileException() [4/4]

FileException::FileException

(

const FileException &

inst

)

Construction.

~FileException()

virtual Base::FileException::~FileException ( ) throw ( )

virtual

Destruction.

Member Function Documentation

getFileName()

std::string FileException::getFileName

(

)

const

Get file name for use with translatable message.

References file, and Base::FileInfo::fileName().

getPyExceptionType()

PyObject * FileException::getPyExceptionType ( void  ) const

overridevirtual

returns the corresponding python exception type

Reimplemented from Base::Exception.

getPyObject()

PyObject * FileException::getPyObject ( void  )

overridevirtual

returns a Python dictionary containing the exception data

Reimplemented from Base::Exception.

References file, Base::FileInfo::fileName(), and Base::Exception::getPyObject().

operator=()

FileException & FileException::operator=

(

const FileException &

inst

)

Assignment operator.

References file, and Base::Exception::operator=().

ReportException()

void FileException::ReportException ( ) const

overridevirtual

Report generation.

Reimplemented from Base::Exception.

setFileName()

void FileException::setFileName ( const char *  sFileName = nullptr )

protected

References file, and Base::FileInfo::setFile().

Referenced by FileException(), and setPyObject().

setPyObject()

void FileException::setPyObject ( PyObject *  pydict )

overridevirtual

returns sets the exception data from a Python dictionary

Reimplemented from Base::Exception.

References setFileName(), and Base::Exception::setPyObject().

what()

const char * FileException::what ( void  ) const throw ( )

overridevirtual

Description of the exception.

Reimplemented from Base::Exception.

Member Data Documentation

file

FileInfo Base::FileException::file

protected

Referenced by exportIFCHelper.ContextCreator::createAutomaticProject(), exportIFCHelper.ContextCreator::createCustomProject(), exportIFCHelper.ContextCreator::createGeometricRepresentationContext(), exportIFCHelper.ContextCreator::createGeometricRepresentationSubContext(), exportIFCHelper.ContextCreator::createMapConversion(), exportIFCHelper.ContextCreator::createTargetCRS(), exportIFCHelper.ContextCreator::createTrueNorth(), getFileName(), getPyObject(), operator=(), importIFClegacy.IfcFile::read(), and setFileName().

---

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

• FreeCAD/src/Base/Exception.h
• FreeCAD/src/Base/Exception.cpp