kim-api 2.4.1+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
 
Loading...
Searching...
No Matches
KIM_CollectionItemType.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.4.1 package.
28//
29
30
31#ifndef KIM_COLLECTION_ITEM_TYPE_HPP_
32#define KIM_COLLECTION_ITEM_TYPE_HPP_
33
34#include <string>
35
36namespace KIM
37{
49{
50 public:
61
66
72 CollectionItemType(int const id);
73
82 CollectionItemType(std::string const & str);
83
93 bool Known() const;
94
103 bool operator==(CollectionItemType const & rhs) const;
104
113 bool operator!=(CollectionItemType const & rhs) const;
114
126 std::string const & ToString() const;
127}; // class CollectionItemType
128
132{
142
152
162
163
174void GetNumberOfCollectionItemTypes(int * const numberOfCollectionItemTypes);
175
191int GetCollectionItemType(int const index,
192 CollectionItemType * const collectionItemType);
193
198{
204 CollectionItemType const & b) const
205 {
207 }
208}; // struct Comparator
209} // namespace COLLECTION_ITEM_TYPE
210} // namespace KIM
211
212#endif // KIM_COLLECTION_ITEM_TYPE_HPP_
An Extensible Enumeration for the CollectionItemType's supported by the KIM API.
bool operator==(CollectionItemType const &rhs) const
Compares CollectionItemType objects for equality.
std::string const & ToString() const
Converts the object to a string.
int collectionItemTypeID
Integer identifying the specific CollectionItemType represented.
bool operator!=(CollectionItemType const &rhs) const
Compares CollectionItemType objects for inequality.
bool Known() const
Determines if the object is a quantity known to the KIM API.
CollectionItemType()
Create an uninitialized CollectionItemType object.
CollectionItemType(std::string const &str)
Create a CollectionItemType object corresponding to the provided string. If the string does not match...
CollectionItemType(int const id)
Create a CollectionItemType object with the specified id.
Contains the enumeration constants and the discovery routines for the CollectionItemType Extensible E...
CollectionItemType const simulatorModel
The standard simulatorModel CollectionItemType.
CollectionItemType const portableModel
The standard portableModel CollectionItemType.
void GetNumberOfCollectionItemTypes(int *const numberOfCollectionItemTypes)
Get the number of standard CollectionItemType's defined by the KIM API.
int GetCollectionItemType(int const index, CollectionItemType *const collectionItemType)
Get the identity of each defined standard CollectionItemType.
CollectionItemType const modelDriver
The standard modelDriver CollectionItemType.
Structure provided for use with std::map.
bool operator()(CollectionItemType const &a, CollectionItemType const &b) const
Provides an (logically unmeaningful) ordering for CollectionItemType objects so that they can be stor...