KIM API V2
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--2018, 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-v2.0.0-beta.0 package.
31 //
32 
33 
34 #ifndef KIM_LOG_HPP_
35 #define KIM_LOG_HPP_
36 
37 #include <string>
38 #include <sstream>
39 
40 namespace KIM
41 {
42 // Forward declarations
43 class LogVerbosity;
44 class LogImplementation;
45 
46 class Log
47 {
48  public:
49  static int Create(Log ** const log);
50  static void Destroy(Log ** const log);
51 
52  std::string const & GetID() const;
53  void SetID(std::string const & id);
54 
55  void PushVerbosity(LogVerbosity const logVerbosity);
56  void PopVerbosity();
57 
58  void LogEntry(LogVerbosity const logVerbosity, std::string const & message,
59  int const lineNumber, std::string const & fileName) const;
60  void LogEntry(LogVerbosity const logVerbosity,
61  std::stringstream const & message,
62  int const lineNumber, std::string const & fileName) const;
63 
64  private:
65  // do not allow copy constructor or operator=
66  Log(Log const &);
67  void operator=(Log const &);
68 
69  Log();
70  ~Log();
71 
72  LogImplementation * pimpl;
73 }; // class Log
74 } // namespace KIM
75 #endif // KIM_LOG_HPP_
std::string const & GetID() const
void PopVerbosity()
void LogEntry(LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
void SetID(std::string const &id)
static void Destroy(Log **const log)
void PushVerbosity(LogVerbosity const logVerbosity)
static int Create(Log **const log)