Exception.h

Go to the documentation of this file.

/** @file Exception.h
* @author Gabor Madl
* @date Created 04/2005
* @brief The Exception class used in DREAM.
*
*
* =================================================================
* DREAM License v2.0
* 
* DREAM - Distributed Real-time Embedded Analysis Method
* http://dre.sourceforge.net.
* Copyright (c) 2005-2007 Gabor Madl, All Rights Reserved.
* 
* This file is part of DREAM.
* 
* DREAM is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation. No future versions of
* the GPL license may be automatically applied to DREAM. It is in
* the sole discretion of the copyright holder to determine whether
* DREAM may be released under a different license or terms. There
* are no restrictions on the use of DREAM for any purpose.
* 
* DREAM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
* 
* By submitting comments, suggestions, code, code snippets,
* techniques (including that of usage), and algorithms, submitters
* acknowledge that they have the right to do so, that any such
* submissions are given freely and unreservedly, and that they
* waive any claims to copyright or ownership. In addition,
* submitters acknowledge that any such submission might become
* part of the copyright maintained on the overall body of code,
* which comprises DREAM. By making a submission, submitter agrees
* to these terms. Furthermore, submitters acknowledge that the
* incorporation or modification of such submissions is entirely
* at the discretion of the moderators of the DREAM project.
* 
* DREAM links to the Libxml2 third party library. Please see 
* COPYING-libxml for the copyright information of Libxml2.
* =================================================================
*/

#ifndef DREAM_EXCEPTION
#define DREAM_EXCEPTION

#include "Common.h"

namespace DREAM
{

/** Generic Exception class used in the whole DREAM implementation. */
class Exception
{
public:
        /** Constructor.
        * @param exception specifies the exception message.
        */
        Exception (const std::string& exception);

        /** Destructor. */
        virtual ~Exception ();

        /** Handler.
        * Outputs exception message.
        */
        virtual void handler () const;
protected:
        /** The exception message */
        std::string exception_;
};

/** Exception class for errors caused by calling unimplemented virtual methods in base classes. */
class BaseClassException : public DREAM::Exception
{
public:
        /** Constructor.
        * @param exception specifies the exception message.
        */
        BaseClassException (const std::string& exception);

        /** Destructor. */
        virtual ~BaseClassException ();

        /** Handler.
        * Outputs exception message.
        */
        virtual void handler () const;
};

/** Exception class for errors reported by the XML parser library. */
class XMLException : public DREAM::Exception
{
public:
        /** Constructor.
        * @param exception specifies the exception message.
        */
        XMLException (const std::string& exception);

        /** Destructor. */
        virtual ~XMLException ();

        /** Handler.
        * Outputs exception message.
        */
        virtual void handler () const;
};

/** Conversion function from const char* to unsigned int. */
uint chartouint (const char* xmlstr)
        throw (DREAM::Exception);
}

#endif

---