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).
Classes | Functions | Variables
KIM::LOG_VERBOSITY Namespace Reference

Contains the enumeration constants and the discovery routines for the LogVerbosity Extensible Enumeration. More...

Classes

struct  Comparator
 Structure provided for use with std::map. More...
 

Functions

void GetNumberOfLogVerbosities (int *const numberOfLogVerbosities)
 Get the number of standard LogVerbosity's defined by the KIM API. More...
 
int GetLogVerbosity (int const index, LogVerbosity *const logVerbosity)
 Get the identity of each defined standard LogVerbosity. More...
 

Variables

LogVerbosity const silent
 The standard silent verbosity. More...
 
LogVerbosity const fatal
 The standard fatal verbosity. More...
 
LogVerbosity const error
 The standard error verbosity. More...
 
LogVerbosity const warning
 The standard warning verbosity. More...
 
LogVerbosity const information
 The standard information verbosity. More...
 
LogVerbosity const debug
 The standard debug verbosity. More...
 

Detailed Description

Contains the enumeration constants and the discovery routines for the LogVerbosity Extensible Enumeration.

Function Documentation

◆ GetLogVerbosity()

int KIM::LOG_VERBOSITY::GetLogVerbosity ( int const  index,
LogVerbosity *const  logVerbosity 
)

Get the identity of each defined standard LogVerbosity.

Parameters
[in]indexZero-based index uniquely labeling each defined standard LogVerbosity. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]logVerbosityThe LogVerbosity object associated with index.
Returns
true if index < 0 or index >= numberOfLogVerbosities.
false otherwise.
See also
KIM_LOG_VERBOSITY_GetLogVerbosity, kim_log_verbosity_module::kim_get_log_verbosity
Since
2.0

◆ GetNumberOfLogVerbosities()

void KIM::LOG_VERBOSITY::GetNumberOfLogVerbosities ( int *const  numberOfLogVerbosities)

Get the number of standard LogVerbosity's defined by the KIM API.

Parameters
[out]numberOfLogVerbositiesThe number of standard LogVerbosity's defined by the KIM API.
See also
KIM_LOG_VERBOSITY_GetNumberOfLogVerbosities, kim_log_verbosity_module::kim_get_number_of_log_verbosities
Since
2.0

Variable Documentation

◆ debug

LogVerbosity const KIM::LOG_VERBOSITY::debug

The standard debug verbosity.

The debug verbosity level should be used when something normal and insignificant happened. Generic examples of a debug condition include: a new user came to the site, a page was rendered, an order was taken, a price was updated. This is the stuff excluded from info because there would be too much of it.

See also
KIM_LOG_VERBOSITY_debug, kim_log_verbosity_module::kim_log_verbosity_debug
Since
2.0

◆ error

LogVerbosity const KIM::LOG_VERBOSITY::error

The standard error verbosity.

The error verbosity level should be used when the execution of some task could not be completed. Generic examples of an error condition include: an email could not be sent, a page could not be rendered, some data could not be stored to a database, etc. Something has definitively gone wrong.

See also
KIM_LOG_VERBOSITY_error, kim_log_verbosity_module::kim_log_verbosity_error
Since
2.0

◆ fatal

LogVerbosity const KIM::LOG_VERBOSITY::fatal

The standard fatal verbosity.

The fatal verbosity level should be used when the execution of the program cannot continue in any way and exit will be called. Generic examples of a fatal condition include: failure to allocate requested memory, etc.

See also
KIM_LOG_VERBOSITY_fatal, kim_log_verbosity_module::kim_log_verbosity_fatal
Since
2.0

◆ information

LogVerbosity const KIM::LOG_VERBOSITY::information

The standard information verbosity.

The information verbosity level should be used when something normal but significant happened. Generic examples of an information condition include: the system started, the system stopped, the daily inventory update job ran, etc. There should not be a continual torrent of these, otherwise there is just too much to read.

See also
KIM_LOG_VERBOSITY_information, kim_log_verbosity_module::kim_log_verbosity_information
Since
2.0

◆ silent

LogVerbosity const KIM::LOG_VERBOSITY::silent

The standard silent verbosity.

The silent verbosity level should be used when absolutely no messages should be written into the log file.

See also
KIM_LOG_VERBOSITY_silent, kim_log_verbosity_module::kim_log_verbosity_silent
Since
2.0

◆ warning

LogVerbosity const KIM::LOG_VERBOSITY::warning

The standard warning verbosity.

The warning verbosity level should be used when something unexpected happened, but that execution can continue, perhaps in a degraded mode. Generic examples of a warning condition include: a configuration file was missing but defaults were used, a price was calculated as negative, so it was clamped to zero, etc. Something is not right, but it has not gone properly wrong yet - warnings are often a sign that there will be an error very soon.

See also
KIM_LOG_VERBOSITY_warning, kim_log_verbosity_module::kim_log_verbosity_warning
Since
2.0