kim-api  2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_LogVerbosity.h
Go to the documentation of this file.
1 /* */
2 /* KIM-API: An API for interatomic models */
3 /* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
4 /* All rights reserved. */
5 /* */
6 /* Contributors: */
7 /* Ryan S. Elliott */
8 /* */
9 /* SPDX-License-Identifier: LGPL-2.1-or-later */
10 /* */
11 /* This library is free software; you can redistribute it and/or */
12 /* modify it under the terms of the GNU Lesser General Public */
13 /* License as published by the Free Software Foundation; either */
14 /* version 2.1 of the License, or (at your option) any later version. */
15 /* */
16 /* This library is distributed in the hope that it will be useful, */
17 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
19 /* Lesser General Public License for more details. */
20 /* */
21 /* You should have received a copy of the GNU Lesser General Public License */
22 /* along with this library; if not, write to the Free Software Foundation, */
23 /* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
24 /* */
25 
26 /* */
27 /* Release: This file is part of the kim-api-2.3.0 package. */
28 /* */
29 
30 
31 #ifndef KIM_LOG_VERBOSITY_H_
32 #define KIM_LOG_VERBOSITY_H_
33 
34 
43 {
53 };
54 #ifndef KIM_LOG_VERBOSITY_DEFINED_
55 #define KIM_LOG_VERBOSITY_DEFINED_
56 
62 #endif
63 
72 KIM_LogVerbosity KIM_LogVerbosity_FromString(char const * const str);
73 
81 int KIM_LogVerbosity_Known(KIM_LogVerbosity const logVerbosity);
82 
92  KIM_LogVerbosity const rhs);
93 
103  KIM_LogVerbosity const rhs);
104 
114  KIM_LogVerbosity const rhs);
115 
125  KIM_LogVerbosity const rhs);
126 
136  KIM_LogVerbosity const rhs);
137 
147  KIM_LogVerbosity const rhs);
148 
156 char const * KIM_LogVerbosity_ToString(KIM_LogVerbosity const logVerbosity);
157 
167 
177 
187 
197 
207 
217 
227  int * const numberOfLogVerbosities);
228 
237 int KIM_LOG_VERBOSITY_GetLogVerbosity(int const index,
238  KIM_LogVerbosity * const logVerbosity);
239 
240 #endif /* KIM_LOG_VERBOSITY_H_ */
int KIM_LogVerbosity_Equal(KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
Compares LogVerbosity objects for equality.
int KIM_LogVerbosity_NotEqual(KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
Compares LogVerbosity objects for inequality.
void KIM_LOG_VERBOSITY_GetNumberOfLogVerbosities(int *const numberOfLogVerbosities)
Get the number of standard LogVerbosity's defined by the KIM API.
int KIM_LOG_VERBOSITY_GetLogVerbosity(int const index, KIM_LogVerbosity *const logVerbosity)
Get the identity of each defined standard LogVerbosity.
KIM_LogVerbosity const KIM_LOG_VERBOSITY_debug
The standard debug verbosity.
int KIM_LogVerbosity_GreaterThan(KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
Compares LogVerbosity objects for greater-than.
int KIM_LogVerbosity_LessThan(KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
Compares LogVerbosity objects for less-than.
char const * KIM_LogVerbosity_ToString(KIM_LogVerbosity const logVerbosity)
Converts the object to a string.
int KIM_LogVerbosity_LessThanEqual(KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
Compares LogVerbosity objects for less-than-equal.
KIM_LogVerbosity const KIM_LOG_VERBOSITY_warning
The standard warning verbosity.
KIM_LogVerbosity const KIM_LOG_VERBOSITY_silent
The standard silent verbosity.
KIM_LogVerbosity const KIM_LOG_VERBOSITY_information
The standard information verbosity.
KIM_LogVerbosity const KIM_LOG_VERBOSITY_fatal
The standard fatal verbosity.
KIM_LogVerbosity KIM_LogVerbosity_FromString(char const *const str)
Create a LogVerbosity object corresponding to the provided string. If the string does not match one o...
int KIM_LogVerbosity_GreaterThanEqual(KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
Compares LogVerbosity objects for greater-than-equal.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
KIM_LogVerbosity const KIM_LOG_VERBOSITY_error
The standard error verbosity.
int logVerbosityID
Integer identifying the specific LogVerbosity represented.
int KIM_LogVerbosity_Known(KIM_LogVerbosity const logVerbosity)
Determines if the object is a quantity known to the KIM API.