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_ModelRoutineName.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_MODEL_ROUTINE_NAME_HPP_
32#define KIM_MODEL_ROUTINE_NAME_HPP_
33
34#include <string>
35
36namespace KIM
37{
49{
50 public:
62
67
73 ModelRoutineName(int const id);
74
83 ModelRoutineName(std::string const & str);
84
93 bool Known() const;
94
103 bool operator==(ModelRoutineName const & rhs) const;
104
113 bool operator!=(ModelRoutineName const & rhs) const;
114
126 std::string const & ToString() const;
127}; // class ModelRoutineName
128
131namespace MODEL_ROUTINE_NAME
132{
144extern ModelRoutineName const Create;
145
160
172extern ModelRoutineName const Compute;
173
185extern ModelRoutineName const Extension;
186
198extern ModelRoutineName const Refresh;
199
214
229
241extern ModelRoutineName const Destroy;
242
243
254void GetNumberOfModelRoutineNames(int * const numberOfModelRoutineNames);
255
271int GetModelRoutineName(int const index,
272 ModelRoutineName * const modelRoutineName);
273
278{
283 bool operator()(ModelRoutineName const & a, ModelRoutineName const & b) const
284 {
286 }
287}; // struct Comparator
288} // namespace MODEL_ROUTINE_NAME
289} // namespace KIM
290
291#endif // KIM_MODEL_ROUTINE_NAME_HPP_
An Extensible Enumeration for the ModelRoutineName's supported by the KIM API.
bool operator==(ModelRoutineName const &rhs) const
Compares ModelRoutineName objects for equality.
ModelRoutineName(int const id)
Create a ModelRoutineName object with the specified id.
bool operator!=(ModelRoutineName const &rhs) const
Compares ModelRoutineName objects for inequality.
ModelRoutineName(std::string const &str)
Create a ModelRoutineName object corresponding to the provided string. If the string does not match o...
std::string const & ToString() const
Converts the object to a string.
int modelRoutineNameID
Integer identifying the specific ModelRoutineName represented.
bool Known() const
Determines if the object is a quantity known to the KIM API.
ModelRoutineName()
Create an uninitialized ModelRoutineName object.
ModelRoutineName const Destroy
The standard Destroy routine.
ModelRoutineName const Create
The standard Create routine.
ModelRoutineName const Compute
The standard Compute routine.
ModelRoutineName const Refresh
The standard Refresh routine.
ModelRoutineName const ComputeArgumentsDestroy
The standard ComputeArgumentsDestroy routine.
ModelRoutineName const WriteParameterizedModel
The standard WriteParameterizedModel routine.
void GetNumberOfModelRoutineNames(int *const numberOfModelRoutineNames)
Get the number of standard ModelRoutineName's defined by the KIM API.
ModelRoutineName const Extension
The standard Extension routine.
ModelRoutineName const ComputeArgumentsCreate
The standard ComputeArgumentsCreate routine.
int GetModelRoutineName(int const index, ModelRoutineName *const modelRoutineName)
Get the identity of each defined standard ModelRoutineName.
Structure provided for use with std::map.
bool operator()(ModelRoutineName const &a, ModelRoutineName const &b) const
Provides an (logically unmeaningful) ordering for ModelRoutineName objects so that they can be stored...