src/CPPAdapter/FinleyAdapterException.h


/* $Id$ */

/*******************************************************
*
*           Copyright 2003-2007 by ACceSS MNRF
*       Copyright 2007 by University of Queensland
*
*                http://esscc.uq.edu.au
*        Primary Business: Queensland, Australia
*  Licensed under the Open Software License version 3.0
*     http://www.opensource.org/licenses/osl-3.0.php
*
*******************************************************/

#if !defined  finley_FinleyAdapterException_20040526_H
#define finley_FinleyAdapterException_20040526_H
#include "system_dep.h"

#include "esysUtils/EsysException.h"

namespace finley
{

  /**
  \brief
  FinleyAdapterException exception class.

  Description:
  FinleyAdapterException exception class.
  The class provides a public function returning the exception name
  */
  class FinleyAdapterException : public esysUtils::EsysException
  {

  protected:

     typedef EsysException Parent;

  public:
    /**
    \brief
    Default constructor for the exception.
    */
    FINLEY_DLL_API
    FinleyAdapterException() : Parent() { updateMessage();}
    /**
    \brief
    Constructor for the exception.
    */
    FINLEY_DLL_API
    FinleyAdapterException(const char *cstr) : Parent(cstr) { updateMessage();}
    /**
    \brief
    Constructor for the exception.
    */
    FINLEY_DLL_API
    FinleyAdapterException(const std::string &str) :
    Parent(str) { updateMessage();}
    /**
    \brief
    Copy Constructor for the exception.
    */
    FINLEY_DLL_API
    FinleyAdapterException(const FinleyAdapterException &other) : Parent(other)
      {
        updateMessage();
      }

    /// Destructor
    FINLEY_DLL_API
    virtual ~FinleyAdapterException() THROW() {}
    /**
    \brief
    Returns the name of the exception.
    */
    FINLEY_DLL_API
    virtual const std::string & exceptionName() const;

  private:

    //
    // the exception name is immutable and class-wide.
    // Inheritor note; you need one of these too.
    // and an overloaded exceptionName() in your .cpp implementation file. 
    static const std::string exceptionNameValue;
  };

} // end of namespace
#endif
1	ksteube	1312
2			/* $Id$ */
3
4			/*******************************************************
5	trankine	1442	*
6			* Copyright 2003-2007 by ACceSS MNRF
7			* Copyright 2007 by University of Queensland
8			*
9			* http://esscc.uq.edu.au
10			* Primary Business: Queensland, Australia
11			* Licensed under the Open Software License version 3.0
12			* http://www.opensource.org/licenses/osl-3.0.php
13			*
14			*******************************************************/
15	ksteube	1312
16	jgs	82	#if !defined finley_FinleyAdapterException_20040526_H
17			#define finley_FinleyAdapterException_20040526_H
18	woo409	757	#include "system_dep.h"
19	jgs	82
20	robwdcock	682	#include "esysUtils/EsysException.h"
21	jgs	472
22	trankine	1442	namespace finley
23			{
24	jgs	82
25	trankine	1442	/**
26			\brief
27			FinleyAdapterException exception class.
28	jgs	82
29	trankine	1442	Description:
30			FinleyAdapterException exception class.
31			The class provides a public function returning the exception name
32			*/
33			class FinleyAdapterException : public esysUtils::EsysException
34			{
35	jgs	82
36	phornby	1449	protected:
37
38			typedef EsysException Parent;
39
40	trankine	1442	public:
41			/**
42			\brief
43			Default constructor for the exception.
44			*/
45	phornby	1451	FINLEY_DLL_API
46	phornby	1450	FinleyAdapterException() : Parent() { updateMessage();}
47	trankine	1442	/**
48			\brief
49			Constructor for the exception.
50			*/
51	phornby	1451	FINLEY_DLL_API
52	phornby	1450	FinleyAdapterException(const char *cstr) : Parent(cstr) { updateMessage();}
53	trankine	1442	/**
54			\brief
55			Constructor for the exception.
56			*/
57	phornby	1451	FINLEY_DLL_API
58	phornby	1450	FinleyAdapterException(const std::string &str) :
59			Parent(str) { updateMessage();}
60			/**
61			\brief
62			Copy Constructor for the exception.
63			*/
64	phornby	1451	FINLEY_DLL_API
65	phornby	1450	FinleyAdapterException(const FinleyAdapterException &other) : Parent(other)
66			{
67			updateMessage();
68			}
69	jgs	82
70	trankine	1442	/// Destructor
71			FINLEY_DLL_API
72	phornby	1447	virtual ~FinleyAdapterException() THROW() {}
73	trankine	1442	/**
74			\brief
75			Returns the name of the exception.
76			*/
77			FINLEY_DLL_API
78			virtual const std::string & exceptionName() const;
79	phornby	1020
80	trankine	1442	private:
81	jgs	82
82	trankine	1442	//
83			// the exception name is immutable and class-wide.
84			// Inheritor note; you need one of these too.
85			// and an overloaded exceptionName() in your .cpp implementation file.
86			static const std::string exceptionNameValue;
87			};
88
89	jgs	82	} // end of namespace
90			#endif
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision