src/gromacs/utility/errorcodes.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2015 by the GROMACS development team.
   5  * Copyright (c) 2016,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \file
  37  * \brief
  38  * Declares error codes and related functions for fatal error handling.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_ERRORCODES_H
  44 #define GMX_UTILITY_ERRORCODES_H
  45
  46 namespace gmx
  47 {
  48
  49 /*! \addtogroup module_utility
  50  * \{
  51  */
  52
  53 /*! \brief
  54  * Possible error return codes from Gromacs functions.
  55  */
  56 enum ErrorCode
  57 {
  58     //! Zero for successful return.
  59     eeOK,
  60
  61     //! Not enough memory to complete operation.
  62     eeOutOfMemory,
  63     //! Provided file could not be opened.
  64     eeFileNotFound,
  65     //! System I/O error.
  66     eeFileIO,
  67     //! Invalid user input (could not be understood).
  68     eeInvalidInput,
  69     //! Invalid user input (conflicting or unsupported settings).
  70     eeInconsistentInput,
  71     //! Requested tolerance cannot be achieved.
  72     eeTolerance,
  73     //! Simulation instability detected.
  74     eeInstability,
  75
  76     /*! \name Error codes for buggy code
  77      *
  78      * Error codes below are for internal error checking; if triggered, they
  79      * should indicate a bug in the code.
  80      * \{
  81      */
  82     //! Requested feature not yet implemented.
  83     eeNotImplemented,
  84     //! Input value violates API specification.
  85     eeInvalidValue,
  86     //! Invalid routine called or wrong calling sequence detected.
  87     eeInvalidCall,
  88     //! Internal consistency check failed.
  89     eeInternalError,
  90     //! API specification was violated.
  91     eeAPIError,
  92     //! Range consistency check failed.
  93     eeRange,
  94
  95     //! Parallel consistency check failed.
  96     eeParallelConsistency,
  97     //!\}
  98
  99     //! Unknown error detected.
 100     eeUnknownError,
 101 };
 102
 103 /*! \brief
 104  * Returns a short string description of an error code.
 105  *
 106  * \param[in] errorcode Error code to retrieve the string for.
 107  * \returns   A constant string corresponding to \p errorcode.
 108  *
 109  * If \p errorcode is not one of those defined for ::gmx::ErrorCode,
 110  * the string corresponding to ::eeUnknownError is returned.
 111  *
 112  * This function does not throw.
 113  */
 114 const char* getErrorCodeString(int errorcode);
 115
 116 /*!\}*/
 117
 118 } // namespace gmx
 119
 120 #endif