kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.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 /* CDDL HEADER START */
3 /* */
4 /* The contents of this file are subject to the terms of the Common */
5 /* Development and Distribution License Version 1.0 (the "License"). */
6 /* */
7 /* You can obtain a copy of the license at */
8 /* http://www.opensource.org/licenses/CDDL-1.0. See the License for the */
9 /* specific language governing permissions and limitations under the License. */
10 /* */
11 /* When distributing Covered Code, include this CDDL HEADER in each file and */
12 /* include the License file in a prominent location with the name */
13 /* LICENSE.CDDL. */
14 /* If applicable, add the following below this CDDL HEADER, with the fields */
15 /* enclosed by brackets "[]" replaced with your own identifying information: */
16 /* */
17 /* Portions Copyright (c) [yyyy] [name of copyright owner]. */
18 /* All rights reserved. */
19 /* */
20 /* CDDL HEADER END */
21 /* */
22 
23 /* */
24 /* Copyright (c) 2016--2019, Regents of the University of Minnesota. */
25 /* All rights reserved. */
26 /* */
27 /* Contributors: */
28 /* Ryan S. Elliott */
29 /* */
30 
31 /* */
32 /* Release: This file is part of the kim-api.git repository. */
33 /* */
34 
35 
36 #ifndef KIM_LOG_VERBOSITY_H_
37 #define KIM_LOG_VERBOSITY_H_
38 
39 #ifndef KIM_LOG_DEFINES_INC_
40 #include "KIM_LOG_DEFINES.inc"
41 #endif
42 
51 {
61 };
62 #ifndef KIM_LOG_VERBOSITY_DEFINED_
63 #define KIM_LOG_VERBOSITY_DEFINED_
64 
70 #endif
71 
80 KIM_LogVerbosity KIM_LogVerbosity_FromString(char const * const str);
81 
89 int KIM_LogVerbosity_Known(KIM_LogVerbosity const logVerbosity);
90 
100  KIM_LogVerbosity const rhs);
101 
111  KIM_LogVerbosity const rhs);
112 
122  KIM_LogVerbosity const rhs);
123 
133  KIM_LogVerbosity const rhs);
134 
144  KIM_LogVerbosity const rhs);
145 
155  KIM_LogVerbosity const rhs);
156 
164 char const * KIM_LogVerbosity_ToString(KIM_LogVerbosity const logVerbosity);
165 
175 
185 
195 
205 
215 
225 
235  int * const numberOfLogVerbosities);
236 
245 int KIM_LOG_VERBOSITY_GetLogVerbosity(int const index,
246  KIM_LogVerbosity * const logVerbosity);
247 
248 #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.