EDoc::BugException Class Reference

#include <include/EDoc/exceptions.h>

Inheritance diagram for EDoc::BugException:

---

Detailed Description

Definition at line 246 of file exceptions.h.

Public Member Functions
	BugException (const char *type_name_in, const char *file_in, int line_in, std::string user_message_in="", std::string dev_message_in="")
	(BRIEF DESC NOT PROVIDED).
	BugException (const char *file_in, int line_in, std::string user_message_in="", std::string dev_message_in="")
	(BRIEF DESC NOT PROVIDED).
virtual const char *	what () const throw ()
	Return a string of information so that this can be used as a std::exception instance.
std::string	GetType () const
	Returns the name of the type of exception that was thrown.
std::string	GetFile () const
	Returns the name of the source file from where the exception was thrown.
int	GetLine () const
	Returns the line number of the source file from where the exception was thrown.
std::string	GetUserMessage () const
	Returns the succinct message describing the error for the user.
std::string	GetDevMessage () const
	Returns the more detailed message describing the error for a developer.

---

Constructor & Destructor Documentation

EDoc::BugException::BugException	(	const char *	type_name_in,
		const char *	file_in,
		int	line_in,
		std::string	user_message_in = "",
		std::string	dev_message_in = ""
	)			[inline]

(BRIEF DESC NOT PROVIDED).

Note:

EDoc++ data included.

Definition at line 246 of file exceptions.h.

EDoc::BugException::BugException	(	const char *	file_in,
		int	line_in,
		std::string	user_message_in = "",
		std::string	dev_message_in = ""
	)			[inline]

(BRIEF DESC NOT PROVIDED).

Note:

EDoc++ data included.

Definition at line 246 of file exceptions.h.

---

Member Function Documentation

EDoc::Throwable::what

(

)

const throw () [virtual, inherited]

Return a string of information so that this can be used as a std::exception instance.

Note:

EDoc++ data included.

Definition at line 46 of file exceptions.cpp.

References EDoc::Throwable::detailed_message.

Referenced by EDoc::Persistence::ReadOpen().

EDoc::Throwable::GetType

(

)

const [inherited]

Returns the name of the type of exception that was thrown.

Note:

EDoc++ data included.

Definition at line 51 of file exceptions.cpp.

References EDoc::Throwable::type_name.

EDoc::Throwable::GetFile

(

)

const [inherited]

Returns the name of the source file from where the exception was thrown.

Note:

EDoc++ data included.

Definition at line 56 of file exceptions.cpp.

References EDoc::Throwable::file.

EDoc::Throwable::GetLine

(

)

const [inherited]

Returns the line number of the source file from where the exception was thrown.

Note:

EDoc++ data included.

Definition at line 61 of file exceptions.cpp.

References EDoc::Throwable::line.

EDoc::Throwable::GetUserMessage

(

)

const [inherited]

Returns the succinct message describing the error for the user.

Note:

EDoc++ data included.

Definition at line 66 of file exceptions.cpp.

References EDoc::Throwable::user_message.

EDoc::Throwable::GetDevMessage

(

)

const [inherited]

Returns the more detailed message describing the error for a developer.

Note:

EDoc++ data included.

Definition at line 71 of file exceptions.cpp.

References EDoc::Throwable::dev_message.

---

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

• include/EDoc/exceptions.h
• libs.dox

---