kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_LanguageName.h
Go to the documentation of this file.
1/* */
2/* KIM-API: An API for interatomic models */
3/* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
4/* All rights reserved. */
5/* */
6/* Contributors: */
7/* Ryan S. Elliott */
8/* */
9/* SPDX-License-Identifier: LGPL-2.1-or-later */
10/* */
11/* This library is free software; you can redistribute it and/or */
12/* modify it under the terms of the GNU Lesser General Public */
13/* License as published by the Free Software Foundation; either */
14/* version 2.1 of the License, or (at your option) any later version. */
15/* */
16/* This library is distributed in the hope that it will be useful, */
17/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
19/* Lesser General Public License for more details. */
20/* */
21/* You should have received a copy of the GNU Lesser General Public License */
22/* along with this library; if not, write to the Free Software Foundation, */
23/* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
24/* */
25
26/* */
27/* Release: This file is part of the kim-api-2.3.0 package. */
28/* */
29
30
31#ifndef KIM_LANGUAGE_NAME_H_
32#define KIM_LANGUAGE_NAME_H_
33
42{
52};
53#ifndef KIM_LANGUAGE_NAME_DEFINED_
54#define KIM_LANGUAGE_NAME_DEFINED_
61#endif
62
72
81
91 KIM_LanguageName const rhs);
92
102 KIM_LanguageName const rhs);
103
111char const * KIM_LanguageName_ToString(KIM_LanguageName const languageName);
112
122
131
141
151 int * const numberOfLanguageNames);
152
162 KIM_LanguageName * const languageName);
163
164#endif /* KIM_LANGUAGE_NAME_H_ */
void KIM_LANGUAGE_NAME_GetNumberOfLanguageNames(int *const numberOfLanguageNames)
Get the number of standard LanguageName's defined by the KIM API.
int KIM_LANGUAGE_NAME_GetLanguageName(int const index, KIM_LanguageName *const languageName)
Get the identity of each defined standard LanguageName.
int KIM_LanguageName_Equal(KIM_LanguageName const lhs, KIM_LanguageName const rhs)
Compares LanguageName objects for equality.
int KIM_LanguageName_Known(KIM_LanguageName const languageName)
Determines if the object is a quantity known to the KIM API.
int KIM_LanguageName_NotEqual(KIM_LanguageName const lhs, KIM_LanguageName const rhs)
Compares LanguageName objects for inequality.
KIM_LanguageName const KIM_LANGUAGE_NAME_fortran
The standard fortran language.
char const * KIM_LanguageName_ToString(KIM_LanguageName const languageName)
Converts the object to a string.
KIM_LanguageName const KIM_LANGUAGE_NAME_c
The standard c language.
KIM_LanguageName const KIM_LANGUAGE_NAME_cpp
The standard cpp language.
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 o...
An Extensible Enumeration for the LanguageName's supported by the KIM API.
int languageNameID
Integer identifying the specific LanguageName represented.