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,2016, 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
  37  * Declares error codes and related functions for fatal error handling.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #ifndef GMX_UTILITY_ERRORCODES_H
  43 #define GMX_UTILITY_ERRORCODES_H
  44
  45 namespace gmx
  46 {
  47
  48 /*! \addtogroup module_utility
  49  * \{
  50  */
  51
  52 /*! \brief
  53  * Possible error return codes from Gromacs functions.
  54  */
  55 enum ErrorCode
  56 {
  57     //! Zero for successful return.
  58     eeOK,
  59
  60     //! Not enough memory to complete operation.
  61     eeOutOfMemory,
  62     //! Provided file could not be opened.
  63     eeFileNotFound,
  64     //! System I/O error.
  65     eeFileIO,
  66     //! Invalid user input (could not be understood).
  67     eeInvalidInput,
  68     //! Invalid user input (conflicting or unsupported settings).
  69     eeInconsistentInput,
  70     //! Requested tolerance cannot be achieved.
  71     eeTolerance,
  72     //! Simulation instability detected.
  73     eeInstability,
  74
  75     /*! \name Error codes for buggy code
  76      *
  77      * Error codes below are for internal error checking; if triggered, they
  78      * should indicate a bug in the code.
  79      * \{
  80      */
  81     //! Requested feature not yet implemented.
  82     eeNotImplemented,
  83     //! Input value violates API specification.
  84     eeInvalidValue,
  85     //! Invalid routine called or wrong calling sequence detected.
  86     eeInvalidCall,
  87     //! Internal consistency check failed.
  88     eeInternalError,
  89     //! API specification was violated.
  90     eeAPIError,
  91     //! Range consistency check failed.
  92     eeRange,
  93     //! Communication consistency check failed.
  94     eeCommunication,
  95     //!\}
  96
  97     //! Unknown error detected.
  98     eeUnknownError,
  99 };
 100
 101 /*! \brief
 102  * Returns a short string description of an error code.
 103  *
 104  * \param[in] errorcode Error code to retrieve the string for.
 105  * \returns   A constant string corresponding to \p errorcode.
 106  *
 107  * If \p errorcode is not one of those defined for ::gmx::ErrorCode,
 108  * the string corresponding to ::eeUnknownError is returned.
 109  *
 110  * This function does not throw.
 111  */
 112 const char *getErrorCodeString(int errorcode);
 113
 114 /*!\}*/
 115
 116 } // namespace gmx
 117
 118 #endif