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).
Public Member Functions | Public Attributes | List of all members
KIM::LogVerbosity Class Reference

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

#include <KIM_LogVerbosity.hpp>

Public Member Functions

 LogVerbosity ()
 Create an uninitialized LogVerbosity object. More...
 
 LogVerbosity (int const id)
 Create a LogVerbosity object with the specified id. More...
 
 LogVerbosity (std::string 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...
 
bool Known () const
 Determines if the object is a quantity known to the KIM API. More...
 
bool operator< (LogVerbosity const &rhs) const
 Compares LogVerbosity objects for less-than. More...
 
bool operator> (LogVerbosity const &rhs) const
 Compares LogVerbosity objects for greater-than. More...
 
bool operator<= (LogVerbosity const &rhs) const
 Compares LogVerbosity objects for less-than-equal. More...
 
bool operator>= (LogVerbosity const &rhs) const
 Compares LogVerbosity objects for greater-than-equal. More...
 
bool operator== (LogVerbosity const &rhs) const
 Compares LogVerbosity objects for equality. More...
 
bool operator!= (LogVerbosity const &rhs) const
 Compares LogVerbosity objects for inequality. More...
 
std::string const & ToString () const
 Converts the object to a string. More...
 

Public Attributes

int logVerbosityID
 Integer identifying the specific LogVerbosity represented. More...
 

Detailed Description

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

The enumeration constants are contained in the LOG_VERBOSITY namespace.

See also
KIM_LogVerbosity, kim_log_verbosity_module::kim_log_verbosity_type
Since
2.0

Definition at line 54 of file KIM_LogVerbosity.hpp.

Constructor & Destructor Documentation

◆ LogVerbosity() [1/3]

KIM::LogVerbosity::LogVerbosity ( )

Create an uninitialized LogVerbosity object.

Since
2.0

◆ LogVerbosity() [2/3]

KIM::LogVerbosity::LogVerbosity ( int const  id)

Create a LogVerbosity object with the specified id.

Note
This should not be used directly.
Since
2.0

◆ LogVerbosity() [3/3]

KIM::LogVerbosity::LogVerbosity ( std::string 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_FromString, kim_log_verbosity_module::kim_from_string
Since
2.0

Member Function Documentation

◆ Known()

bool KIM::LogVerbosity::Known ( ) const

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

LogVerbosity's known to the KIM API are found in the LOG_VERBOSITY namespace.

See also
KIM_LogVerbosity_Known, kim_log_verbosity_module::kim_known
Since
2.0

◆ operator!=()

bool KIM::LogVerbosity::operator!= ( LogVerbosity const &  rhs) const

Compares LogVerbosity objects for inequality.

Note
It is possible for two "unknown" objects to be not equal.
See also
KIM_LogVerbosity_NotEqual, kim_log_verbosity_module::operator(.ne.)
Since
2.0

◆ operator<()

bool KIM::LogVerbosity::operator< ( LogVerbosity const &  rhs) const

Compares LogVerbosity objects for less-than.

See also
KIM_LogVerbosity_LessThan, kim_log_verbosity_module::operator(.lt.)
Since
2.0

◆ operator<=()

bool KIM::LogVerbosity::operator<= ( LogVerbosity const &  rhs) const

Compares LogVerbosity objects for less-than-equal.

See also
KIM_LogVerbosity_LessThanEqual, kim_log_verbosity_module::operator(.le.)
Since
2.0

◆ operator==()

bool KIM::LogVerbosity::operator== ( LogVerbosity const &  rhs) const

Compares LogVerbosity objects for equality.

Note
Not all "unknown" objects are equal.
See also
KIM_LogVerbosity_Equal, kim_log_verbosity_module::operator(.eq.)
Since
2.0

◆ operator>()

bool KIM::LogVerbosity::operator> ( LogVerbosity const &  rhs) const

Compares LogVerbosity objects for greater-than.

See also
KIM_LogVerbosity_GreaterThan, kim_log_verbosity_module::operator(.gt.)
Since
2.0

◆ operator>=()

bool KIM::LogVerbosity::operator>= ( LogVerbosity const &  rhs) const

Compares LogVerbosity objects for greater-than-equal.

See also
KIM_LogVerbosity_GreaterThanEqual, kim_log_verbosity_module::operator(.ge.)
Since
2.0

◆ ToString()

std::string const& KIM::LogVerbosity::ToString ( ) const

Converts the object to a string.

Returns
A string object representing the LogVerbosity object.
Note
If the LogVerbosity object does not correspond to a value defined by the KIM API, then the string "unknown" is returned.
See also
KIM_LogVerbosity_ToString, kim_log_verbosity_module::kim_to_string
Since
2.0

Member Data Documentation

◆ logVerbosityID

int KIM::LogVerbosity::logVerbosityID

Integer identifying the specific LogVerbosity represented.

Note
This should not be directly accessed and is only public for cross-language reasons.
See also
KIM_LogVerbosity::logVerbosityID, kim_log_verbosity_module::kim_log_verbosity_type::log_verbosity_id
Since
2.0

Definition at line 66 of file KIM_LogVerbosity.hpp.


The documentation for this class was generated from the following file: