Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

SPARK::XAssertion Class Reference

Base class for all SPARK exceptions. More...

#include <exceptions.h>

Inheritance diagram for SPARK::XAssertion:

Inheritance graph
[legend]
List of all members.

Public Types

typedef enum ExitCodes TCode
 Locally rename ExitCodes as TCode.


Public Member Functions

 XAssertion (const std::string &type, const std::string &where, const std::string &message, TCode code)
 Constructor with message specified as std::string.

 XAssertion (const XAssertion &x)
 Copy constructor.

virtual ~XAssertion () throw ()
 Trivial destructor.

virtual const char * what () const throw ()
 Returns a description of the exception as a const char*.

const char * type () const throw ()
 Returns type of the exception as const char*.

const char * message () const throw ()
 Returns message associated with the exception as const char*.

const char * where () const throw ()
 Returns where the exception was thrown from as const char*.

TCode code () const throw ()
 Returns code of the exception as TCode.

XAssertion & operator[] (const std::string &where)
 Appends sender's information to Where string following " <- ".

XAssertion & operator() (const std::string &msg)
 Appends msg to Message string on a new line.

Detailed Description

Base class for all SPARK exceptions.
Examples:

multiproblem_example1.cpp, and sparksolver.cpp.

Member Typedef Documentation

typedef enum ExitCodes SPARK::XAssertion::TCode
 

Locally rename ExitCodes as TCode.

Constructor & Destructor Documentation

SPARK::XAssertion::XAssertion (  const std::string &  type,
const std::string &  where,
const std::string &  message,
TCode  code
)  [inline]
 

Constructor with message specified as std::string.

SPARK::XAssertion::XAssertion (  const XAssertion &  x  )  [inline]
 

Copy constructor.

virtual SPARK::XAssertion::~XAssertion (   )  throw () [inline, virtual]
 

Trivial destructor.

Member Function Documentation

virtual const char* SPARK::XAssertion::what (   )  const throw () [virtual]
 

Returns a description of the exception as a const char*.

const char* SPARK::XAssertion::type (   )  const throw () [inline]
 

Returns type of the exception as const char*.

const char* SPARK::XAssertion::message (   )  const throw () [inline]
 

Returns message associated with the exception as const char*.

const char* SPARK::XAssertion::where (   )  const throw () [inline]
 

Returns where the exception was thrown from as const char*.

TCode SPARK::XAssertion::code (   )  const throw () [inline]
 

Returns code of the exception as TCode.

XAssertion& SPARK::XAssertion::operator[] (  const std::string &  where  ) 
 

Appends sender's information to Where string following " <- ".

XAssertion& SPARK::XAssertion::operator() (  const std::string &  msg  ) 
 

Appends msg to Message string on a new line.

The documentation for this class was generated from the following file:
Generated on 5 Nov 2003 for VisualSPARK 2.01