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_LanguageName.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

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

Typedefs

typedef struct KIM_LanguageName KIM_LanguageName
 Convenience typedef. More...
 

Functions

KIM_LanguageName KIM_LanguageName_FromString (char const *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...
 
int KIM_LanguageName_Known (KIM_LanguageName const languageName)
 Determines if the object is a quantity known to the KIM API. More...
 
int KIM_LanguageName_Equal (KIM_LanguageName const lhs, KIM_LanguageName const rhs)
 Compares LanguageName objects for equality. More...
 
int KIM_LanguageName_NotEqual (KIM_LanguageName const lhs, KIM_LanguageName const rhs)
 Compares LanguageName objects for inequality. More...
 
char const * KIM_LanguageName_ToString (KIM_LanguageName const languageName)
 Converts the object to a string. More...
 
void KIM_LANGUAGE_NAME_GetNumberOfLanguageNames (int *const numberOfLanguageNames)
 Get the number of standard LanguageName's defined by the KIM API. More...
 
int KIM_LANGUAGE_NAME_GetLanguageName (int const index, KIM_LanguageName *const languageName)
 Get the identity of each defined standard LanguageName. More...
 

Variables

KIM_LanguageName const KIM_LANGUAGE_NAME_cpp
 The standard cpp language. More...
 
KIM_LanguageName const KIM_LANGUAGE_NAME_c
 The standard c language. More...
 
KIM_LanguageName const KIM_LANGUAGE_NAME_fortran
 The standard fortran language. More...
 

Typedef Documentation

◆ KIM_LanguageName

Convenience typedef.

Since
2.0

Definition at line 65 of file KIM_LanguageName.h.

Function Documentation

◆ KIM_LANGUAGE_NAME_GetLanguageName()

int KIM_LANGUAGE_NAME_GetLanguageName ( int const  index,
KIM_LanguageName *const  languageName 
)

Get the identity of each defined standard LanguageName.

See also
KIM::LANGUAGE_NAME::GetLanguageName, kim_language_name_module::kim_get_language_name
Since
2.0

◆ KIM_LANGUAGE_NAME_GetNumberOfLanguageNames()

void KIM_LANGUAGE_NAME_GetNumberOfLanguageNames ( int *const  numberOfLanguageNames)

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

◆ KIM_LanguageName_Equal()

int KIM_LanguageName_Equal ( KIM_LanguageName const  lhs,
KIM_LanguageName const  rhs 
)

Compares LanguageName objects for equality.

See also
KIM::LanguageName::operator==(), kim_language_name_module::operator(.eq.)
Since
2.0

◆ KIM_LanguageName_FromString()

KIM_LanguageName KIM_LanguageName_FromString ( char const *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::LanguageName(std::string const &), kim_language_name_module::kim_from_string
Since
2.0

◆ KIM_LanguageName_Known()

int KIM_LanguageName_Known ( KIM_LanguageName const  languageName)

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

See also
KIM::LanguageName::Known, kim_language_name_module::kim_known
Since
2.0

◆ KIM_LanguageName_NotEqual()

int KIM_LanguageName_NotEqual ( KIM_LanguageName const  lhs,
KIM_LanguageName const  rhs 
)

Compares LanguageName objects for inequality.

See also
KIM::LanguageName::operator!=(), kim_language_name_module::operator(.ne.)
Since
2.0

◆ KIM_LanguageName_ToString()

char const* KIM_LanguageName_ToString ( KIM_LanguageName const  languageName)

Converts the object to a string.

See also
KIM::LanguageName::ToString, kim_language_name_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_LANGUAGE_NAME_c

KIM_LanguageName const KIM_LANGUAGE_NAME_c

The standard c language.

See also
KIM::LANGUAGE_NAME::c, kim_language_name_module::kim_language_name_c
Since
2.0

◆ KIM_LANGUAGE_NAME_cpp

KIM_LanguageName const KIM_LANGUAGE_NAME_cpp

The standard cpp language.

See also
KIM::LANGUAGE_NAME::cpp, kim_language_name_module::kim_language_name_cpp
Since
2.0

◆ KIM_LANGUAGE_NAME_fortran

KIM_LanguageName const KIM_LANGUAGE_NAME_fortran

The standard fortran language.

See also
KIM::LANGUAGE_NAME::fortran, kim_language_name_module::kim_language_name_fortran
Since
2.0