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.hpp
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_HPP_
32#define KIM_LANGUAGE_NAME_HPP_
33
34#include <string>
35
36namespace KIM
37{
47{
48 public:
59
64
70 LanguageName(int const id);
71
80 LanguageName(std::string const & str);
81
90 bool Known() const;
91
99 bool operator==(LanguageName const & rhs) const;
100
108 bool operator!=(LanguageName const & rhs) const;
109
120 std::string const & ToString() const;
121}; // class LanguageName
122
125namespace LANGUAGE_NAME
126{
134extern LanguageName const cpp;
135
143extern LanguageName const c;
144
153extern LanguageName const fortran;
154
155
166void GetNumberOfLanguageNames(int * const numberOfLanguageNames);
167
182int GetLanguageName(int const index, LanguageName * const languageName);
183
188{
193 bool operator()(LanguageName const & a, LanguageName const & b) const
194 {
195 return a.languageNameID < b.languageNameID;
196 }
197}; // struct Comparator
198} // namespace LANGUAGE_NAME
199} // namespace KIM
200
201#endif // KIM_LANGUAGE_NAME_HPP_
An Extensible Enumeration for the LanguageName's supported by the KIM API.
LanguageName(int const id)
Create a LanguageName object with the specified id.
bool operator==(LanguageName const &rhs) const
Compares LanguageName objects for equality.
LanguageName()
Create an uninitialized LanguageName object.
bool Known() const
Determines if the object is a quantity known to the KIM API.
std::string const & ToString() const
Converts the object to a string.
bool operator!=(LanguageName const &rhs) const
Compares LanguageName objects for inequality.
int languageNameID
Integer identifying the specific LanguageName represented.
LanguageName(std::string const &str)
Create a LanguageName object corresponding to the provided string. If the string does not match one o...
int GetLanguageName(int const index, LanguageName *const languageName)
Get the identity of each defined standard LanguageName.
void GetNumberOfLanguageNames(int *const numberOfLanguageNames)
Get the number of standard LanguageName's defined by the KIM API.
LanguageName const cpp
The standard cpp language.
LanguageName const c
The standard c language.
LanguageName const fortran
The standard fortran language.
Structure provided for use with std::map.
bool operator()(LanguageName const &a, LanguageName const &b) const
Provides an (logically unmeaningful) ordering for LanguageName objects so that they can be stored in ...