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 | Typedefs | Functions | Variables
KIM_LogVerbosity.h File Reference
#include "KIM_LOG_DEFINES.inc"
Include dependency graph for KIM_LogVerbosity.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  KIM_LogVerbosity
 An Extensible Enumeration for the LogVerbosity's supported by the KIM API. More...
 

Typedefs

typedef struct KIM_LogVerbosity KIM_LogVerbosity
 Convenience typedef. More...
 

Functions

KIM_LogVerbosity KIM_LogVerbosity_FromString (char const *const str)
 Create a LogVerbosity object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated. More...
 
int KIM_LogVerbosity_Known (KIM_LogVerbosity const logVerbosity)
 Determines if the object is a quantity known to the KIM API. More...
 
int KIM_LogVerbosity_LessThan (KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
 Compares LogVerbosity objects for less-than. More...
 
int KIM_LogVerbosity_GreaterThan (KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
 Compares LogVerbosity objects for greater-than. More...
 
int KIM_LogVerbosity_LessThanEqual (KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
 Compares LogVerbosity objects for less-than-equal. More...
 
int KIM_LogVerbosity_GreaterThanEqual (KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
 Compares LogVerbosity objects for greater-than-equal. More...
 
int KIM_LogVerbosity_Equal (KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
 Compares LogVerbosity objects for equality. More...
 
int KIM_LogVerbosity_NotEqual (KIM_LogVerbosity const lhs, KIM_LogVerbosity const rhs)
 Compares LogVerbosity objects for inequality. More...
 
char const * KIM_LogVerbosity_ToString (KIM_LogVerbosity const logVerbosity)
 Converts the object to a string. More...
 
void KIM_LOG_VERBOSITY_GetNumberOfLogVerbosities (int *const numberOfLogVerbosities)
 Get the number of standard LogVerbosity's defined by the KIM API. More...
 
int KIM_LOG_VERBOSITY_GetLogVerbosity (int const index, KIM_LogVerbosity *const logVerbosity)
 Get the identity of each defined standard LogVerbosity. More...
 

Variables

KIM_LogVerbosity const KIM_LOG_VERBOSITY_silent
 The standard silent verbosity. More...
 
KIM_LogVerbosity const KIM_LOG_VERBOSITY_fatal
 The standard fatal verbosity. More...
 
KIM_LogVerbosity const KIM_LOG_VERBOSITY_error
 The standard error verbosity. More...
 
KIM_LogVerbosity const KIM_LOG_VERBOSITY_warning
 The standard warning verbosity. More...
 
KIM_LogVerbosity const KIM_LOG_VERBOSITY_information
 The standard information verbosity. More...
 
KIM_LogVerbosity const KIM_LOG_VERBOSITY_debug
 The standard debug verbosity. More...
 

Typedef Documentation

◆ KIM_LogVerbosity

Convenience typedef.

Since
2.0

Definition at line 69 of file KIM_LogVerbosity.h.

Function Documentation

◆ KIM_LOG_VERBOSITY_GetLogVerbosity()

int KIM_LOG_VERBOSITY_GetLogVerbosity ( int const  index,
KIM_LogVerbosity *const  logVerbosity 
)

Get the identity of each defined standard LogVerbosity.

See also
KIM::LOG_VERBOSITY::GetLogVerbosity, kim_log_verbosity_module::kim_get_log_verbosity
Since
2.0

◆ KIM_LOG_VERBOSITY_GetNumberOfLogVerbosities()

void KIM_LOG_VERBOSITY_GetNumberOfLogVerbosities ( int *const  numberOfLogVerbosities)

Get the 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

◆ KIM_LogVerbosity_Equal()

int KIM_LogVerbosity_Equal ( KIM_LogVerbosity const  lhs,
KIM_LogVerbosity const  rhs 
)

Compares LogVerbosity objects for equality.

See also
KIM::LogVerbosity::operator==(), kim_log_verbosity_module::operator(.eq.)
Since
2.0

◆ KIM_LogVerbosity_FromString()

KIM_LogVerbosity KIM_LogVerbosity_FromString ( char const *const  str)

Create a LogVerbosity object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.

See also
KIM::LogVerbosity::LogVerbosity(std::string const &), kim_log_verbosity_module::kim_from_string
Since
2.0

◆ KIM_LogVerbosity_GreaterThan()

int KIM_LogVerbosity_GreaterThan ( KIM_LogVerbosity const  lhs,
KIM_LogVerbosity const  rhs 
)

Compares LogVerbosity objects for greater-than.

See also
KIM::LogVerbosity::operator>(), kim_log_verbosity_module::operator(.gt.)
Since
2.0

◆ KIM_LogVerbosity_GreaterThanEqual()

int KIM_LogVerbosity_GreaterThanEqual ( KIM_LogVerbosity const  lhs,
KIM_LogVerbosity const  rhs 
)

Compares LogVerbosity objects for greater-than-equal.

See also
KIM::LogVerbosity::operator>=(), kim_log_verbosity_module::operator(.ge.)
Since
2.0

◆ KIM_LogVerbosity_Known()

int KIM_LogVerbosity_Known ( KIM_LogVerbosity const  logVerbosity)

Determines if the object is a quantity known to the KIM API.

See also
KIM::LogVerbosity::Known, kim_log_verbosity_module::kim_known
Since
2.0

◆ KIM_LogVerbosity_LessThan()

int KIM_LogVerbosity_LessThan ( KIM_LogVerbosity const  lhs,
KIM_LogVerbosity const  rhs 
)

Compares LogVerbosity objects for less-than.

See also
KIM::LogVerbosity::operator<(), kim_log_verbosity_module::operator(.lt.)
Since
2.0

◆ KIM_LogVerbosity_LessThanEqual()

int KIM_LogVerbosity_LessThanEqual ( KIM_LogVerbosity const  lhs,
KIM_LogVerbosity const  rhs 
)

Compares LogVerbosity objects for less-than-equal.

See also
KIM::LogVerbosity::operator<=(), kim_log_verbosity_module::operator(.le.)
Since
2.0

◆ KIM_LogVerbosity_NotEqual()

int KIM_LogVerbosity_NotEqual ( KIM_LogVerbosity const  lhs,
KIM_LogVerbosity const  rhs 
)

Compares LogVerbosity objects for inequality.

See also
KIM::LogVerbosity::operator!=(), kim_log_verbosity_module::operator(.ne.)
Since
2.0

◆ KIM_LogVerbosity_ToString()

char const* KIM_LogVerbosity_ToString ( KIM_LogVerbosity const  logVerbosity)

Converts the object to a string.

See also
KIM::LogVerbosity::ToString, kim_log_verbosity_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_LOG_VERBOSITY_debug

KIM_LogVerbosity const KIM_LOG_VERBOSITY_debug

The standard debug verbosity.

See also
KIM::LOG_VERBOSITY::debug, kim_log_verbosity_module::kim_log_verbosity_debug
Since
2.0

◆ KIM_LOG_VERBOSITY_error

KIM_LogVerbosity const KIM_LOG_VERBOSITY_error

The standard error verbosity.

See also
KIM::LOG_VERBOSITY::error, kim_log_verbosity_module::kim_log_verbosity_error
Since
2.0

◆ KIM_LOG_VERBOSITY_fatal

KIM_LogVerbosity const KIM_LOG_VERBOSITY_fatal

The standard fatal verbosity.

See also
KIM::LOG_VERBOSITY::fatal, kim_log_verbosity_module::kim_log_verbosity_fatal
Since
2.0

◆ KIM_LOG_VERBOSITY_information

KIM_LogVerbosity const KIM_LOG_VERBOSITY_information

◆ KIM_LOG_VERBOSITY_silent

KIM_LogVerbosity const KIM_LOG_VERBOSITY_silent

The standard silent verbosity.

See also
KIM::LOG_VERBOSITY::silent, kim_log_verbosity_module::kim_log_verbosity_silent
Since
2.0

◆ KIM_LOG_VERBOSITY_warning

KIM_LogVerbosity const KIM_LOG_VERBOSITY_warning

The standard warning verbosity.

See also
KIM::LOG_VERBOSITY::warning, kim_log_verbosity_module::kim_log_verbosity_warning
Since
2.0