1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/* */
/* KIM-API: An API for interatomic models */
/* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
/* All rights reserved. */
/* */
/* Contributors: */
/* Ryan S. Elliott */
/* */
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/* */
/* This library is free software; you can redistribute it and/or */
/* modify it under the terms of the GNU Lesser General Public */
/* License as published by the Free Software Foundation; either */
/* version 2.1 of the License, or (at your option) any later version. */
/* */
/* This library is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
/* Lesser General Public License for more details. */
/* */
/* You should have received a copy of the GNU Lesser General Public License */
/* along with this library; if not, write to the Free Software Foundation, */
/* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
/* */
/* */
/* Release: This file is part of the kim-api.git repository. */
/* */
#ifndef KIM_COLLECTION_H_
#define KIM_COLLECTION_H_
/**
** \brief \copybrief KIM::Collection
**
** \sa KIM::Collection, kim_collection_module::kim_collection_type
**
** \since 2.1
**/
struct KIM_Collection
{
/**
** \brief \copybrief KIM::Collection::collectionID
**
** \sa KIM::Collection::collectionID,
** kim_collection_module::kim_collection_type::collection_id
**
** \since 2.1
**/
int collectionID;
};
#ifndef KIM_COLLECTION_DEFINED_
#define KIM_COLLECTION_DEFINED_
/**
** \brief Convenience typedef.
**
** \since 2.1
**/
typedef struct KIM_Collection KIM_Collection;
#endif
/**
** \brief \copybrief KIM::Collection::Collection(std::string const &)
**
** \sa KIM::Collection::Collection(std::string const &),
** kim_collection_module::kim_from_string
**
** \since 2.1
**/
KIM_Collection KIM_Collection_FromString(char const * const str);
/**
** \brief \copybrief KIM::Collection::Known
**
** \sa KIM::Collection::Known, kim_collection_module::kim_known
**
** \since 2.1
**/
int KIM_Collection_Known(KIM_Collection const collection);
/**
** \brief \copybrief KIM::Collection::operator==()
**
** \sa KIM::Collection::operator==(), kim_collection_module::operator(.eq.)
**
** \since 2.1
**/
int KIM_Collection_Equal(KIM_Collection const lhs, KIM_Collection const rhs);
/**
** \brief \copybrief KIM::Collection::operator!=()
**
** \sa KIM::Collection::operator!=(), kim_collection_module::operator(.ne.)
**
** \since 2.1
**/
int KIM_Collection_NotEqual(KIM_Collection const lhs, KIM_Collection const rhs);
/**
** \brief \copybrief KIM::Collection::ToString
**
** \sa KIM::Collection::ToString, kim_collection_module::kim_to_string
**
** \since 2.1
**/
char const * KIM_Collection_ToString(KIM_Collection const collection);
/**
** \brief \copybrief KIM::COLLECTION::system
**
** \sa KIM::COLLECTION::system,
** kim_collection_module::kim_collection_system
**
** \since 2.1
**/
extern KIM_Collection const KIM_COLLECTION_system;
/**
** \brief \copybrief KIM::COLLECTION::user
**
** \sa KIM::COLLECTION::user,
** kim_collection_module::kim_collection_user
**
** \since 2.1
**/
extern KIM_Collection const KIM_COLLECTION_user;
/**
** \brief \copybrief KIM::COLLECTION::environmentVariable
**
** \sa KIM::COLLECTION::environmentVariable,
** kim_collection_module::kim_collection_environment_variable
**
** \since 2.1
**/
extern KIM_Collection const KIM_COLLECTION_environmentVariable;
/**
** \brief \copybrief KIM::COLLECTION::currentWorkingDirectory
**
** \sa KIM::COLLECTION::currentWorkingDirectory,
** kim_collection_module::kim_collection_current_working_directory
**
** \since 2.1
**/
extern KIM_Collection const KIM_COLLECTION_currentWorkingDirectory;
/**
** \brief \copybrief KIM::COLLECTION::GetNumberOfCollections
**
** \sa KIM::COLLECTION::GetNumberOfCollections,
** kim_collection_module::kim_get_number_of_collections
**
** \since 2.1
**/
void KIM_COLLECTION_GetNumberOfCollections(int * const numberOfCollections);
/**
** \brief \brief \copybrief KIM::COLLECTION::GetCollection
**
** \sa KIM::COLLECTION::GetCollection,
** kim_collection_module::kim_get_collection
**
** \since 2.1
**/
int KIM_COLLECTION_GetCollection(int const index,
KIM_Collection * const collection);
#endif /* KIM_COLLECTION_H_ */
|
