Error Class Reference

Error class. More...

Inheritance diagram for Error:

Collaboration diagram for Error:

Public Member Functions
	Error ()
	Creates a new instance.
	Error (const std::string &mess)
	Creates a new instance. More...
virtual	~Error ()
	Destructor.
const std::string &	Message () const
	Gets the message of the exception. More...
void	SetMessage (const std::string &mess)
	Sets the message of the exception. More...

Static Public Member Functions
static void	ThrowError (int32_t coreErrorCode)
	Throws a new Error instance from a sparksee_core error code. More...

Protected Attributes
std::string	message
	Message of the exception.

Detailed Description

Error class.

An Error corresponds to an unexpected and unpredictable exception.

As all methods can throw an Error at any moment, it is not expected they declare the Error (or subclasses) they may throw.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

Error::Error

(

const std::string &

mess

)

Creates a new instance.

Parameters

mess	[in] Message of the exception.

Member Function Documentation

const std::string& Exception::Message ( ) const

inherited

Gets the message of the exception.

It should be called GetMessage but this is not possible because of a macro defined in Windows.

Returns

The message of the exception.

void Exception::SetMessage ( const std::string &  mess )

inherited

Sets the message of the exception.

Parameters

mess	[in] Message.

static void Error::ThrowError ( int32_t  coreErrorCode )

static

Throws a new Error instance from a sparksee_core error code.

Parameters

coreErrorCode

[in] Sparkseecore error code.

Returns

Depending on the given sparksee_core error, this will throw an Error instance of an specific Error subclass instance.

---

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

• Exception.h