Error Class Reference
[Gdb]

Error class. More...

Inheritance diagram for Error:

Inheritance graph
Collaboration diagram for Error:

Collaboration graph

List of all members.

Public Member Functions

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

Static Public Member Functions

static Error NewError (int32_t coreErrorCode)
 Creates a new Error instance from a sparksee_core error code.

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

static Error Error::NewError ( int32_t  coreErrorCode  )  [static]

Creates 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 may return an Error instance or an specific Error subclass instance.

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.


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

Generated on Fri Sep 12 13:36:30 2014 for Sparksee by  doxygen 1.5.6