AuroraException Class Reference

#include <Exceptions.h>

List of all members.

---

Detailed Description

The base class for all AuroraExceptions.

Currently defined exceptions include

• AuroraNoSuchEntityException: requested an entity which doesn't exist
• AuroraBadXmlException: non-well-formed (i.e., unparseable) XML
• AuroraBadEntityException: semantically invalid entity description (e.g., box doesn't have a type)
• AuroraTypingException: typechecking failed
• AuroraIllegalArgumentException: miscellaneous illegal argument provided

Public Member Functions
	AuroraException (string message, string file=string(), unsigned int line=0, const char *type="AuroraException")
	Constructor.
virtual	~AuroraException () throw ()
	Destructor.
virtual const char *	what () const throw ()
	Returns the message as a C string.
string	getMessage () const
	Returns the message.
string	getFile () const
	Returns the source file in which the exception was thrown (or an empty string if unknown).
unsigned int	getLine () const
	Returns the line number in the source file in which the exception was thrown (or an empty string if unknown).
const char *	getType () const
	Returns the type of the exception (e.g., "AuroraException" or "AuroraNoSuchEntityException").
string	as_string () const
	Returns a description containing all known information about the message.
string	getStackTrace () const
	Returns a stack trace describing where the exception was thrown.

---

Constructor & Destructor Documentation

AuroraException::AuroraException (  string  message, string  file = string(), unsigned int  line = 0, const char *  type = "AuroraException" )

Constructor. An AuroraException should never be thrown directly; use the Throw macro instead. Parameters: message  the exception message file  the source file in which the exception is being thrown line  the line in the source file in which the exception is being thrown type  the type of the exception

AuroraException::~AuroraException (   )  throw () [virtual]

Destructor.

---

Member Function Documentation

string AuroraException::as_string (   )  const

Returns a description containing all known information about the message.

string AuroraException::getFile (   )  const

Returns the source file in which the exception was thrown (or an empty string if unknown).

unsigned int AuroraException::getLine (   )  const

Returns the line number in the source file in which the exception was thrown (or an empty string if unknown).

string AuroraException::getMessage (   )  const

Returns the message.

string AuroraException::getStackTrace (   )  const

Returns a stack trace describing where the exception was thrown. Uses external programs; may be very slow.

const char* AuroraException::getType (   )  const

Returns the type of the exception (e.g., "AuroraException" or "AuroraNoSuchEntityException").

virtual const char* AuroraException::what (   )  const throw () [virtual]

Returns the message as a C string. The string is owned by this object, so the pointer becomes invalid upon description of the AuroraException.

---

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

• Exceptions.h
• Exceptions.cc

---