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_Collection.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_COLLECTION_HPP_
32#define KIM_COLLECTION_HPP_
33
34#include <string>
35
36namespace KIM
37{
47{
48 public:
59
64
70 Collection(int const id);
71
79 Collection(std::string const & str);
80
88 bool Known() const;
89
97 bool operator==(Collection const & rhs) const;
98
107 bool operator!=(Collection const & rhs) const;
108
119 std::string const & ToString() const;
120}; // class Collection
121
124namespace COLLECTION
125{
133extern Collection const system;
134
143extern Collection const user;
144
154
164
165
175void GetNumberOfCollections(int * const numberOfCollections);
176
190int GetCollection(int const index, Collection * const collection);
191
196{
201 bool operator()(Collection const & a, Collection const & b) const
202 {
203 return a.collectionID < b.collectionID;
204 }
205}; // struct Comparator
206} // namespace COLLECTION
207} // namespace KIM
208
209#endif // KIM_COLLECTION_HPP_
An Extensible Enumeration for the Collection's supported by the KIM API.
bool Known() const
Determines if the object is a quantity known to the KIM API.
int collectionID
Integer identifying the specific Collection represented.
Collection(int const id)
Create a Collection object with the specified id.
std::string const & ToString() const
Converts the object to a string.
bool operator!=(Collection const &rhs) const
Compares Collection objects for inequality.
bool operator==(Collection const &rhs) const
Compares Collection objects for equality.
Collection(std::string const &str)
Create a Collection object corresponding to the provided string. If the string does not match one of ...
Collection()
Create an uninitialized Collection object.
Collection const environmentVariable
The standard environmentVariable Collection.
void GetNumberOfCollections(int *const numberOfCollections)
Get the number of standard Collection's defined by the KIM API.
Collection const system
The standard system Collection.
int GetCollection(int const index, Collection *const collection)
Get the identity of each defined standard Collection.
Collection const currentWorkingDirectory
The standard currentWorkingDirectory Collection.
Collection const user
The standard user Collection.
Structure provided for use with std::map.
bool operator()(Collection const &a, Collection const &b) const
Provides an (logically unmeaningful) ordering for Collection objects so that they can be stored in a ...