escript  Revision_Unversioneddirectory
Public Member Functions | Protected Types | Static Private Attributes | List of all members
escript::SolverOptionsException Class Reference

SolverOptionsException exception class. More...

#include <SolverOptionsException.h>

Inheritance diagram for escript::SolverOptionsException:
esysUtils::EsysException

Public Member Functions

 SolverOptionsException ()
 Default constructor for the exception. More...
 
 SolverOptionsException (const char *cstr)
 Constructor with message. More...
 
 SolverOptionsException (const std::string &str)
 Constructor with message. More...
 
 SolverOptionsException (const SolverOptionsException &other)
 Copy Constructor. More...
 
virtual ~SolverOptionsException () THROW(NO_ARG)
 Destructor. More...
 
SolverOptionsExceptionoperator= (const SolverOptionsException &other) THROW(NO_ARG)
 Assignment operator. More...
 
virtual const std::string & exceptionName () const
 Returns the name of the exception. More...
 
- Public Member Functions inherited from esysUtils::EsysException
 EsysException ()
 Default Constructor. Creates an exception with no message. More...
 
 EsysException (const std::string &exceptionReason)
 Constructor which creates a EsysException with the given message. More...
 
 EsysException (const char *cStr)
 Constructor which creates a EsysException with the given message. More...
 
 EsysException (const EsysException &other)
 Copy constructor. More...
 
virtual ~EsysException () throw ( )
 Destructor. More...
 
EsysExceptionoperator= (const EsysException &other) throw ( )
 Assignment needed to override any automatic assignment of std::exception, which can potentially copy around char *'s, causeing trouble in some implementations of STL. It will only copy the reason string, and update the message. More...
 
const std::string & toString () const
 Return the exception message in the form <Exception Name>: <Exception Message>. More...
 
const std::string & reason () const
 Return a reference to the string that contains the exception reason. More...
 
void setReason (const std::string &new_reason)
 set the string for the reason for the exception. This allows ousiders to modify m_reason, but the practice is discouraged. If string insertions are required, use string methods. More...
 
virtual const char * what () const throw ( )
 Return a description of the exception in the same format as the toString method. More...
 
void updateMessage ()
 update m_exceptionMessage after a reason update. More...
 

Protected Types

typedef EsysException Parent
 
- Protected Types inherited from esysUtils::EsysException
typedef std::exception Parent
 

Static Private Attributes

static const std::string exceptionNameValue
 

Detailed Description

SolverOptionsException exception class.

Member Typedef Documentation

Constructor & Destructor Documentation

escript::SolverOptionsException::SolverOptionsException ( )
inline

Default constructor for the exception.

escript::SolverOptionsException::SolverOptionsException ( const char *  cstr)
inline

Constructor with message.

escript::SolverOptionsException::SolverOptionsException ( const std::string &  str)
inline

Constructor with message.

escript::SolverOptionsException::SolverOptionsException ( const SolverOptionsException other)
inline

Copy Constructor.

virtual escript::SolverOptionsException::~SolverOptionsException ( )
inlinevirtual

Destructor.

Member Function Documentation

const std::string & escript::SolverOptionsException::exceptionName ( ) const
virtual

Returns the name of the exception.

Reimplemented from esysUtils::EsysException.

References exceptionNameValue.

SolverOptionsException& escript::SolverOptionsException::operator= ( const SolverOptionsException other)
inline

Assignment operator.

Member Data Documentation

const std::string escript::SolverOptionsException::exceptionNameValue
staticprivate

Referenced by exceptionName().


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