Exception.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

MeRMaID 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename Exception.hpp
 * @Description ReturnValue declaration
 * @Status Work in Progress
 * @Version $Id: Exception.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer nmsra (nmsra@mega.ist.utl.pt)
 */

#ifndef __ERRORRHANDLING_EXCEPTION_H_
#define __ERRORRHANDLING_EXCEPTION_H_

#include <string>
#include <stdexcept>

namespace mermaid
{
  namespace support
  {
    namespace errorhandling
    {
    
    
      /**
      * @Class Exception Exception.hpp "Exception.hpp"
      * @Description Exception base class the represents all exceptions thrown by MeRMaID
      * @Author Marco Barbosa + Nelson Ramos
      */
      class Exception : public std::runtime_error
      {
        public:
          /**
           * @Description Constructor.
           * @Param description Description of the failure that raised this exception.
           * @Author Marco Barbosa + Nelson Ramos
           */
          Exception (const std::string &description);
          
      };
    } // namespace errorhandling
  } // namespace support
} // namespace mermaid

#endif // __ERRORRHANDLING_EXCEPTION_H_