kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_Log.hpp
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 Development
5 // 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 LICENSE.CDDL.
13 // If applicable, add the following below this CDDL HEADER, with the fields
14 // enclosed by brackets "[]" replaced with your own identifying information:
15 //
16 // Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
17 //
18 // CDDL HEADER END
19 //
20 
21 //
22 // Copyright (c) 2016--2019, Regents of the University of Minnesota.
23 // All rights reserved.
24 //
25 // Contributors:
26 // Ryan S. Elliott
27 //
28 
29 //
30 // Release: This file is part of the kim-api.git repository.
31 //
32 
33 
34 #ifndef KIM_LOG_HPP_
35 #define KIM_LOG_HPP_
36 
37 #include <sstream>
38 #include <string>
39 
40 namespace KIM
41 {
42 // Forward declarations
43 class LogVerbosity;
44 class LogImplementation;
45 
51 class Log
52 {
53  public:
63  static int Create(Log ** const log);
64 
76  static void Destroy(Log ** const log);
77 
89  static void PushDefaultVerbosity(LogVerbosity const logVerbosity);
90 
98  static void PopDefaultVerbosity();
99 
105  std::string const & GetID() const;
106 
114  void SetID(std::string const & id);
115 
123  void PushVerbosity(LogVerbosity const logVerbosity);
124 
130  void PopVerbosity();
131 
146  void LogEntry(LogVerbosity const logVerbosity,
147  std::string const & message,
148  int const lineNumber,
149  std::string const & fileName) const;
150 
152  void LogEntry(LogVerbosity const logVerbosity,
153  std::stringstream const & message,
154  int const lineNumber,
155  std::string const & fileName) const;
156 
157  private:
158  // do not allow copy constructor or operator=
159  Log(Log const &);
160  void operator=(Log const &);
161 
162  Log();
163  ~Log();
164 
165  LogImplementation * pimpl;
166 }; // class Log
167 } // namespace KIM
168 
169 #endif // KIM_LOG_HPP_
static void PushDefaultVerbosity(LogVerbosity const logVerbosity)
Push a new default LogVerbosity onto the KIM API global default verbosity stack.
std::string const & GetID() const
Get the identity of the Log object.
void PopVerbosity()
Pop a LogVerbosity from the Log object&#39;s verbosity stack.
static void PopDefaultVerbosity()
Pop a LogVerbosity from the KIM API global default verbosity stack.
Provides the logging interface for the KIM API.
Definition: KIM_Log.hpp:51
void LogEntry(LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
Write a log entry into the log file.
void SetID(std::string const &id)
Set the identity of the Log object.
static void Destroy(Log **const log)
Destroy a previously Log::Create&#39;d object.
An Extensible Enumeration for the LogVerbosity&#39;s supported by the KIM API.
void PushVerbosity(LogVerbosity const logVerbosity)
Push a new LogVerbosity onto the Log object&#39;s verbosity stack.
static int Create(Log **const log)
Create a new KIM API Log object.