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