Escript  Revision_4320
Public Member Functions | Protected Types | Static Private Attributes | List of all members
dudley::DudleyAdapterException Class Reference

DudleyAdapterException exception class. More...

#include <DudleyAdapterException.h>

Inheritance diagram for dudley::DudleyAdapterException:
esysUtils::EsysException

Public Member Functions

 DudleyAdapterException ()
 Default constructor for the exception.
 DudleyAdapterException (const char *cstr)
 Constructor for the exception.
 DudleyAdapterException (const std::string &str)
 Constructor for the exception.
 DudleyAdapterException (const DudleyAdapterException &other)
 Copy Constructor for the exception.
virtual ~DudleyAdapterException () THROW(NO_ARG)
 Destructor.
DudleyAdapterExceptionoperator= (const DudleyAdapterException &other) THROW(NO_ARG)
 Assignment operator.
virtual const std::string & exceptionName () const
 Returns the name of the exception.
- Public Member Functions inherited from esysUtils::EsysException
 EsysException ()
 Default Constructor. Creates an exception with no message.
 EsysException (const std::string &exceptionReason)
 Constructor which creates a EsysException with the given message.
 EsysException (const char *cStr)
 Constructor which creates a EsysException with the given message.
 EsysException (const EsysException &other)
 Copy constructor.
virtual ~EsysException () throw ( )
 Destructor.
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.
const std::string & toString () const
 Return the exception message in the form <Exception Name>: <Exception Message>.
const std::string & reason () const
 Return a reference to the string that contains the exception reason.
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.
virtual const char * what () const throw ( )
 Return a description of the exception in the same format as the toString method.
void updateMessage ()
 update m_exceptionMessage after a reason update.

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

DudleyAdapterException exception class.

Description: DudleyAdapterException exception class. The class provides a public function returning the exception name

Member Typedef Documentation

Constructor & Destructor Documentation

dudley::DudleyAdapterException::DudleyAdapterException ( )
inline

Default constructor for the exception.

References esysUtils::EsysException::updateMessage().

dudley::DudleyAdapterException::DudleyAdapterException ( const char *  cstr)
inline

Constructor for the exception.

References esysUtils::EsysException::updateMessage().

dudley::DudleyAdapterException::DudleyAdapterException ( const std::string &  str)
inline

Constructor for the exception.

References esysUtils::EsysException::updateMessage().

dudley::DudleyAdapterException::DudleyAdapterException ( const DudleyAdapterException other)
inline

Copy Constructor for the exception.

References esysUtils::EsysException::updateMessage().

virtual dudley::DudleyAdapterException::~DudleyAdapterException ( )
inlinevirtual

Destructor.

Member Function Documentation

const std::string & DudleyAdapterException::exceptionName ( ) const
virtual

Returns the name of the exception.

Reimplemented from esysUtils::EsysException.

References exceptionNameValue.

DudleyAdapterException& dudley::DudleyAdapterException::operator= ( const DudleyAdapterException other)
inline

Assignment operator.

References esysUtils::EsysException::updateMessage().

Member Data Documentation

const std::string DudleyAdapterException::exceptionNameValue
staticprivate

Referenced by exceptionName().


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