src/api/cpp/include/gmxapi/compat/exceptions.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief C++ exceptions for the gmxapi compatibility tools.
  37  *
  38  * Used internally for the gmxapi compatibility helpers that manage type
  39  * mappings of older GROMACS structures. The long-term disposition of this
  40  * code is uncertain, but the headers are not likely to be public. If they
  41  * do persist in some form, we can integrate the exception hierarchy into
  42  * whatever module takes ownership of this code.
  43  *
  44  * Exceptions defined here should only be caught by code that understands the
  45  * implementation details of these compatibility tools. Exposure of these
  46  * exceptions outside of the installed object files should be treated as a bug.
  47  *
  48  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  49  * \ingroup gmxapi_compat
  50  */
  51
  52 #ifndef GMXAPICOMPAT_EXCEPTIONS_H
  53 #define GMXAPICOMPAT_EXCEPTIONS_H
  54
  55 #include <exception>
  56 #include <string>
  57
  58 namespace gmxapicompat
  59 {
  60
  61 /*!
  62  * \brief Generic exception class for gmxapicompat.
  63  */
  64 class Exception : public std::exception
  65 {
  66     public:
  67         using std::exception::exception;
  68
  69         explicit Exception(const std::string &message) :
  70             message_ {message}
  71         {}
  72         explicit Exception(const char* message) : Exception(std::string(message)) {}
  73
  74         const char *what() const noexcept override
  75         {
  76             return message_.c_str();
  77         }
  78
  79     private:
  80         std::string message_;
  81 };
  82
  83 /*!
  84  * \brief The key name provided for a key-value mapping is invalid.
  85  */
  86 class KeyError : public Exception
  87 {
  88     using Exception::Exception;
  89 };
  90
  91 /*!
  92  * \brief The value provided for a key-value mapping is invalid.
  93  */
  94 class ValueError : public Exception
  95 {
  96     using Exception::Exception;
  97 };
  98
  99 /*!
 100  * \brief Value provided for a key-value mapping is of an incompatible type.
 101  */
 102 class TypeError : public Exception
 103 {
 104     using Exception::Exception;
 105 };
 106
 107 }      // end namespace gmxapicompat
 108 #endif //GMXAPICOMPAT_EXCEPTIONS_H