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

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

#include <KIM_LanguageName.hpp>

Public Member Functions

 LanguageName ()
 Create an uninitialized LanguageName object. More...
 
 LanguageName (int const id)
 Create a LanguageName object with the specified id. More...
 
 LanguageName (std::string const &str)
 Create a LanguageName 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== (LanguageName const &rhs) const
 Compares LanguageName objects for equality. More...
 
bool operator!= (LanguageName const &rhs) const
 Compares LanguageName objects for inequality. More...
 
std::string const & ToString () const
 Converts the object to a string. More...
 

Public Attributes

int languageNameID
 Integer identifying the specific LanguageName represented. More...
 

Detailed Description

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

The enumeration constants are contained in the LANGUAGE_NAME namespace.

See also
KIM_LanguageName, kim_language_name_module::kim_language_name_type
Since
2.0

Definition at line 49 of file KIM_LanguageName.hpp.

Constructor & Destructor Documentation

◆ LanguageName() [1/3]

KIM::LanguageName::LanguageName ( )

Create an uninitialized LanguageName object.

Since
2.0

◆ LanguageName() [2/3]

KIM::LanguageName::LanguageName ( int const  id)

Create a LanguageName object with the specified id.

Note
This should not be used directly.
Since
2.0

◆ LanguageName() [3/3]

KIM::LanguageName::LanguageName ( std::string const &  str)

Create a LanguageName 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_LanguageName_FromString, kim_language_name_module::kim_from_string
Since
2.0

Member Function Documentation

◆ Known()

bool KIM::LanguageName::Known ( ) const

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

LanguageName's known to the KIM API are found in the LANGUAGE_NAME namespace.

See also
KIM_LanguageName_Known, kim_language_name_module::kim_known
Since
2.0

◆ operator!=()

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

Compares LanguageName objects for inequality.

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

◆ operator==()

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

Compares LanguageName objects for equality.

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

◆ ToString()

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

Converts the object to a string.

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

Member Data Documentation

◆ languageNameID

int KIM::LanguageName::languageNameID

Integer identifying the specific LanguageName represented.

Note
This should not be directly accessed and is only public for cross-language reasons.
See also
KIM_LanguageName::languageNameID, kim_language_name_module::kim_language_name_type::language_name_id
Since
2.0

Definition at line 61 of file KIM_LanguageName.hpp.


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