api/nblib/exception.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, 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 /*! \inpublicapi \file
  36  * \brief
  37  * Implements nblib exception class
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  */
  44 #ifndef NBLIB_EXCEPTION_H
  45 #define NBLIB_EXCEPTION_H
  46
  47 #include <exception>
  48 #include <string>
  49
  50 namespace nblib
  51 {
  52
  53 /*! \brief Base nblib exception class
  54  *
  55  * All nblib exceptions derive from this class and simply forward their message. This allows
  56  * exceptions to be handled uniformly across different exception types.
  57  */
  58 class NbLibException : public std::exception
  59 {
  60 public:
  61     [[maybe_unused]] explicit NbLibException(const std::string& message) :
  62         message_("NbLib Exception: " + message)
  63     {
  64     }
  65
  66     //! Overrides the what() in std::exception
  67     [[nodiscard]] const char* what() const noexcept override { return message_.c_str(); }
  68
  69     //! Convenience call in case a string is wanted instead of a const char*
  70     [[nodiscard]] const std::string& reason() const& { return message_; }
  71
  72 private:
  73     std::string message_;
  74 };
  75
  76 /*! \brief The exception type for user input errors
  77  *
  78  * The message should give users some hint as to how to remedy the error.
  79  */
  80 class InputException final : NbLibException
  81 {
  82 public:
  83     using NbLibException::NbLibException;
  84 };
  85
  86 } // namespace nblib
  87 #endif // NBLIB_EXCEPTION_H