Provides the logging interface for the KIM API.
More...
#include <KIM_Log.hpp>
Provides the logging interface for the KIM API.
- See also
- KIM_Log, kim_log_module::kim_log_handle_type
- Since
- 2.0
Definition at line 51 of file KIM_Log.hpp.
◆ Create()
static int KIM::Log::Create |
( |
Log **const |
log | ) |
|
|
static |
◆ Destroy()
static void KIM::Log::Destroy |
( |
Log **const |
log | ) |
|
|
static |
◆ GetID()
std::string const& KIM::Log::GetID |
( |
| ) |
const |
Get the identity of the Log object.
- See also
- KIM_Log_GetID, kim_log_module::kim_get_id
- Since
- 2.0
◆ LogEntry() [1/2]
void KIM::Log::LogEntry |
( |
LogVerbosity const |
logVerbosity, |
|
|
std::string const & |
message, |
|
|
int const |
lineNumber, |
|
|
std::string const & |
fileName |
|
) |
| const |
Write a log entry into the log file.
This results in a no-op if logVerbosity
is LOG_VERBOSITY::silent or if logVerbosity
is greater-than the Log object's top LogVerbosity on its stack.
- Parameters
-
[in] | logVerbosity | The LogVerbosity level for the entry. |
[in] | message | The body text of the log entry. |
[in] | lineNumber | The source code file line number. |
[in] | fileName | The source code file name. |
- See also
- KIM_Log_LogEntry, kim_log_module::kim_log_entry
- Since
- 2.0
◆ LogEntry() [2/2]
void KIM::Log::LogEntry |
( |
LogVerbosity const |
logVerbosity, |
|
|
std::stringstream const & |
message, |
|
|
int const |
lineNumber, |
|
|
std::string const & |
fileName |
|
) |
| const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ PopDefaultVerbosity()
static void KIM::Log::PopDefaultVerbosity |
( |
| ) |
|
|
static |
◆ PopVerbosity()
void KIM::Log::PopVerbosity |
( |
| ) |
|
◆ PushDefaultVerbosity()
static void KIM::Log::PushDefaultVerbosity |
( |
LogVerbosity const |
logVerbosity | ) |
|
|
static |
◆ PushVerbosity()
void KIM::Log::PushVerbosity |
( |
LogVerbosity const |
logVerbosity | ) |
|
◆ SetID()
void KIM::Log::SetID |
( |
std::string const & |
id | ) |
|
Set the identity of the Log object.
- Parameters
-
[in] | id | String identifying the Log object. |
- See also
- KIM_Log_SetID, kim_log_module::kim_set_id
- Since
- 2.0
The documentation for this class was generated from the following file: