kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_LogVerbosity.hpp
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_HPP_
32#define KIM_LOG_VERBOSITY_HPP_
33
34#include <string>
35
36
37namespace KIM
38{
49{
50 public:
61
66
72 LogVerbosity(int const id);
73
82 LogVerbosity(std::string const & str);
83
92 bool Known() const;
93
99 bool operator<(LogVerbosity const & rhs) const;
100
107 bool operator>(LogVerbosity const & rhs) const;
108
115 bool operator<=(LogVerbosity const & rhs) const;
116
123 bool operator>=(LogVerbosity const & rhs) const;
124
132 bool operator==(LogVerbosity const & rhs) const;
133
141 bool operator!=(LogVerbosity const & rhs) const;
142
153 std::string const & ToString() const;
154}; // class LogVerbosity
155
158namespace LOG_VERBOSITY
159{
169extern LogVerbosity const silent;
170
182extern LogVerbosity const fatal;
183
195extern LogVerbosity const error;
196
211extern LogVerbosity const warning;
212
225extern LogVerbosity const information;
226
239extern LogVerbosity const debug;
240
241
252void GetNumberOfLogVerbosities(int * const numberOfLogVerbosities);
253
268int GetLogVerbosity(int const index, LogVerbosity * const logVerbosity);
269
274{
279 bool operator()(LogVerbosity const & a, LogVerbosity const & b) const
280 {
281 return a.logVerbosityID < b.logVerbosityID;
282 }
283}; // struct Comparator
284} // namespace LOG_VERBOSITY
285} // namespace KIM
286
287#endif // KIM_LOG_VERBOSITY_HPP_
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
std::string const & ToString() const
Converts the object to a string.
bool operator>(LogVerbosity const &rhs) const
Compares LogVerbosity objects for greater-than.
bool operator==(LogVerbosity const &rhs) const
Compares LogVerbosity objects for equality.
bool Known() const
Determines if the object is a quantity known to the KIM API.
bool operator>=(LogVerbosity const &rhs) const
Compares LogVerbosity objects for greater-than-equal.
LogVerbosity()
Create an uninitialized LogVerbosity object.
bool operator<=(LogVerbosity const &rhs) const
Compares LogVerbosity objects for less-than-equal.
LogVerbosity(int const id)
Create a LogVerbosity object with the specified id.
LogVerbosity(std::string const &str)
Create a LogVerbosity object corresponding to the provided string. If the string does not match one o...
bool operator!=(LogVerbosity const &rhs) const
Compares LogVerbosity objects for inequality.
int logVerbosityID
Integer identifying the specific LogVerbosity represented.
bool operator<(LogVerbosity const &rhs) const
Compares LogVerbosity objects for less-than.
LogVerbosity const error
The standard error verbosity.
void GetNumberOfLogVerbosities(int *const numberOfLogVerbosities)
Get the number of standard LogVerbosity's defined by the KIM API.
int GetLogVerbosity(int const index, LogVerbosity *const logVerbosity)
Get the identity of each defined standard LogVerbosity.
LogVerbosity const debug
The standard debug verbosity.
LogVerbosity const fatal
The standard fatal verbosity.
LogVerbosity const warning
The standard warning verbosity.
LogVerbosity const information
The standard information verbosity.
LogVerbosity const silent
The standard silent verbosity.
Structure provided for use with std::map.
bool operator()(LogVerbosity const &a, LogVerbosity const &b) const
Provides an (logically unmeaningful) ordering for LogVerbosity objects so that they can be stored in ...