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

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

Classes

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

Functions

void GetNumberOfLanguageNames (int *const numberOfLanguageNames)
 Get the number of standard LanguageName's defined by the KIM API. More...
 
int GetLanguageName (int const index, LanguageName *const languageName)
 Get the identity of each defined standard LanguageName. More...
 

Variables

LanguageName const cpp
 The standard cpp language. More...
 
LanguageName const c
 The standard c language. More...
 
LanguageName const fortran
 The standard fortran language. More...
 

Detailed Description

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

Function Documentation

◆ GetLanguageName()

int KIM::LANGUAGE_NAME::GetLanguageName ( int const  index,
LanguageName *const  languageName 
)

Get the identity of each defined standard LanguageName.

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

◆ GetNumberOfLanguageNames()

void KIM::LANGUAGE_NAME::GetNumberOfLanguageNames ( int *const  numberOfLanguageNames)

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

Parameters
[out]numberOfLanguageNamesThe number of standard LanguageName's defined by the KIM API.
See also
KIM_LANGUAGE_NAME_GetNumberOfLanguageNames, kim_language_name_module::kim_get_number_of_language_names
Since
2.0

Variable Documentation

◆ c

LanguageName const KIM::LANGUAGE_NAME::c

The standard c language.

Todo:
Add more detailed description of the language.
See also
KIM_LANGUAGE_NAME_c, kim_language_name_module::kim_language_name_c
Since
2.0

◆ cpp

LanguageName const KIM::LANGUAGE_NAME::cpp

The standard cpp language.

Todo:
Add more detailed description of the language.
See also
KIM_LANGUAGE_NAME_cpp, kim_language_name_module::kim_language_name_cpp
Since
2.0

◆ fortran

LanguageName const KIM::LANGUAGE_NAME::fortran

The standard fortran language.

Todo:
Add more detailed description of the language.
See also
KIM_LANGUAGE_NAME_fortran, kim_language_name_module::kim_language_name_fortran
Since
2.0