EDM4eic
EIC data model
Loading...
Searching...
No Matches
InclusiveKinematicsCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_InclusiveKinematicsCollection_H
4#define EDM4EIC_InclusiveKinematicsCollection_H
5
6// datamodel specific includes
11
12// podio specific includes
13#include "podio/ICollectionProvider.h"
14#include "podio/CollectionBase.h"
15
16#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
17#include "nlohmann/json_fwd.hpp"
18#endif
19
20#include <string_view>
21#include <vector>
22#include <algorithm>
23#include <ostream>
24#include <mutex>
25#include <memory>
26#include <cstddef>
27
28namespace podio {
29 struct RelationNames;
30}
31
32namespace edm4eic {
33
34
35
37public:
39 using difference_type = ptrdiff_t;
42 using iterator_category = std::input_iterator_tag;
43 // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
44 // remain valid as long as the iterator is valid, not as long as the range is valid.
45 using iterator_concept = std::random_access_iterator_tag;
46
47 InclusiveKinematicsCollectionIterator(size_t index, const InclusiveKinematicsObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<InclusiveKinematicsObj>{nullptr}), m_collection(collection) {}
49
55
57 return m_index <=> other.m_index;
58 }
59
61 return m_index == x.m_index;
62 }
63
64 reference operator*() const;
77
78private:
79 size_t m_index{0};
80 InclusiveKinematics m_object { podio::utils::MaybeSharedPtr<InclusiveKinematicsObj>{nullptr} };
81 const InclusiveKinematicsObjPointerContainer* m_collection{nullptr};
82};
83
84
86public:
88 using difference_type = ptrdiff_t;
91 using iterator_category = std::input_iterator_tag;
92 // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
93 // remain valid as long as the iterator is valid, not as long as the range is valid.
94 using iterator_concept = std::random_access_iterator_tag;
95
96 InclusiveKinematicsMutableCollectionIterator(size_t index, const InclusiveKinematicsObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<InclusiveKinematicsObj>{nullptr}), m_collection(collection) {}
98
104
106 return m_index <=> other.m_index;
107 }
108
110 return m_index == x.m_index;
111 }
112
113 reference operator*() const;
126
127private:
128 size_t m_index{0};
129 MutableInclusiveKinematics m_object { podio::utils::MaybeSharedPtr<InclusiveKinematicsObj>{nullptr} };
130 const InclusiveKinematicsObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class InclusiveKinematicsCollection : public podio::CollectionBase {
138public:
143 using difference_type = ptrdiff_t;
144 using size_type = size_t;
145 using const_reverse_iterator = std::reverse_iterator<const_iterator>;
146 using reverse_iterator = std::reverse_iterator<iterator>;
147
150 // This is a move-only type
155
156// InclusiveKinematicsCollection(InclusiveKinematicsVector* data, uint32_t collectionID);
158
159 constexpr static std::string_view typeName = "edm4eic::InclusiveKinematicsCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::InclusiveKinematics";
161 constexpr static std::string_view dataTypeName = "edm4eic::InclusiveKinematicsData";
162
163 void clear() final;
164
165 /// Print this collection to the passed stream
166 void print(std::ostream& os=std::cout, bool flush=true) const final;
167
168 /// operator to allow pointer like calling of members a la LCIO
169 InclusiveKinematicsCollection* operator->() { return static_cast<InclusiveKinematicsCollection*>(this); }
170
171 /// Append a new object to the collection, and return this object.
173
174 /// Append a new object to the collection, and return this object.
175 /// Initialized with the parameters given
176 template<typename... Args>
177 MutableInclusiveKinematics create(Args&&... args);
178
179 /// number of elements in the collection
180 std::size_t size() const final;
181
182 /// maximal number of elements in the collection
183 std::size_t max_size() const final;
184
185 /// Is the collection empty
186 bool empty() const final;
187
188 /// fully qualified type name
189 const std::string_view getTypeName() const final { return typeName; }
190 /// fully qualified type name of elements - with namespace
191 const std::string_view getValueTypeName() const final { return valueTypeName; }
192 /// fully qualified type name of stored POD elements - with namespace
193 const std::string_view getDataTypeName() const final { return dataTypeName; }
194 /// schema version
195 podio::SchemaVersionT getSchemaVersion() const final;
196
197 bool isSubsetCollection() const final {
198 return m_isSubsetColl;
199 }
200
201 void setSubsetCollection(bool setSubset=true) final;
202
203 /// Returns the const object of given index
204 InclusiveKinematics operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableInclusiveKinematics operator[](std::size_t index);
207 /// Returns the const object of given index
208 InclusiveKinematics at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableInclusiveKinematics at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableInclusiveKinematics& object);
215 /// Append an object to the (subset) collection
216 void push_back(const InclusiveKinematics& object);
217
218 void prepareForWrite() const final;
219 void prepareAfterRead() final;
220 bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
221
222 /// Get the collection buffers for this collection
223 podio::CollectionWriteBuffers getBuffers() final;
224
225 void setID(uint32_t ID) final {
226 m_collectionID = ID;
227 if (!m_isSubsetColl) {
228 std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
229 [ID] (InclusiveKinematicsObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
230 );
231 }
232 m_isValid = true;
233 }
234
235 uint32_t getID() const final {
236 return m_collectionID;
237 }
238
239 bool isValid() const final {
240 return m_isValid;
241 }
242
243 size_t getDatamodelRegistryIndex() const final;
244
245 // support for the iterator protocol
247 return iterator(0, &m_storage.entries);
248 }
250 return const_iterator(0, &m_storage.entries);
251 }
253 return begin();
254 }
256 return iterator(m_storage.entries.size(), &m_storage.entries);
257 }
259 return const_iterator(m_storage.entries.size(), &m_storage.entries);
260 }
262 return end();
263 }
264 // reverse iterators
266 return reverse_iterator(end());
267 }
272 return rbegin();
273 }
275 return reverse_iterator(begin());
276 }
281 return rend();
282 }
283
284
285 std::vector<float> x(const size_t nElem = 0) const;
286 std::vector<float> Q2(const size_t nElem = 0) const;
287 std::vector<float> W(const size_t nElem = 0) const;
288 std::vector<float> y(const size_t nElem = 0) const;
289 std::vector<float> nu(const size_t nElem = 0) const;
290
291private:
292 // For setReferences, we need to give our own CollectionData access to our
293 // private entries. Otherwise we would need to expose a public member function
294 // that gives access to the Obj* which is definitely not what we want
296
297 bool m_isValid{false};
298 mutable bool m_isPrepared{false};
299 bool m_isSubsetColl{false};
300 uint32_t m_collectionID{0};
301 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
302 mutable InclusiveKinematicsCollectionData m_storage{};
303};
304
305std::ostream& operator<<(std::ostream& o, const InclusiveKinematicsCollection& v);
306
307template<typename... Args>
309 if (m_isSubsetColl) {
310 throw std::logic_error("Cannot create new elements on a subset collection");
311 }
312 const int size = m_storage.entries.size();
313 auto obj = new InclusiveKinematicsObj({size, m_collectionID}, {std::forward<Args>(args)...});
314 m_storage.entries.push_back(obj);
315
316 return MutableInclusiveKinematics(podio::utils::MaybeSharedPtr(obj));
317}
318
319#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
320void to_json(nlohmann::json& j, const InclusiveKinematicsCollection& collection);
321#endif
322
323} // namespace edm4eic
324
325
326#endif
Definition InclusiveKinematicsCollectionData.h:31
Definition InclusiveKinematicsCollection.h:137
uint32_t getID() const final
Definition InclusiveKinematicsCollection.h:235
~InclusiveKinematicsCollection() override
Definition InclusiveKinematicsCollection.cc:30
void setID(uint32_t ID) final
Definition InclusiveKinematicsCollection.h:225
const std::string_view getTypeName() const final
fully qualified type name
Definition InclusiveKinematicsCollection.h:189
void clear() final
Definition InclusiveKinematicsCollection.cc:91
friend class InclusiveKinematicsCollectionData
Definition InclusiveKinematicsCollection.h:295
bool isValid() const final
Definition InclusiveKinematicsCollection.h:239
bool empty() const final
Is the collection empty.
Definition InclusiveKinematicsCollection.cc:65
InclusiveKinematicsCollection(InclusiveKinematicsCollection &&)=default
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition InclusiveKinematicsCollection.cc:476
void prepareAfterRead() final
Definition InclusiveKinematicsCollection.cc:105
InclusiveKinematics value_type
Definition InclusiveKinematicsCollection.h:139
const_reverse_iterator rbegin() const
Definition InclusiveKinematicsCollection.h:268
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition InclusiveKinematicsCollection.h:145
reverse_iterator rend()
Definition InclusiveKinematicsCollection.h:274
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition InclusiveKinematicsCollection.cc:156
InclusiveKinematicsCollection()
Definition InclusiveKinematicsCollection.cc:24
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition InclusiveKinematicsCollection.h:191
std::size_t size() const final
number of elements in the collection
Definition InclusiveKinematicsCollection.cc:51
const_reverse_iterator rend() const
Definition InclusiveKinematicsCollection.h:277
const_iterator cend() const
Definition InclusiveKinematicsCollection.h:261
InclusiveKinematicsCollection & operator=(const InclusiveKinematicsCollection &)=delete
size_t size_type
Definition InclusiveKinematicsCollection.h:144
void prepareForWrite() const final
Definition InclusiveKinematicsCollection.cc:96
InclusiveKinematicsCollectionIterator const_iterator
Definition InclusiveKinematicsCollection.h:141
MutableInclusiveKinematics create()
Append a new object to the collection, and return this object.
Definition InclusiveKinematicsCollection.cc:80
InclusiveKinematicsCollection(const InclusiveKinematicsCollection &)=delete
InclusiveKinematicsCollection & operator=(InclusiveKinematicsCollection &&)=default
const_iterator cbegin() const
Definition InclusiveKinematicsCollection.h:252
void push_back(const MutableInclusiveKinematics &object)
Append object to the collection.
Definition InclusiveKinematicsCollection.cc:124
const_reverse_iterator crbegin() const
Definition InclusiveKinematicsCollection.h:271
void setSubsetCollection(bool setSubset=true) final
Definition InclusiveKinematicsCollection.cc:69
std::reverse_iterator< iterator > reverse_iterator
Definition InclusiveKinematicsCollection.h:146
const_iterator begin() const
Definition InclusiveKinematicsCollection.h:249
static constexpr std::string_view dataTypeName
Definition InclusiveKinematicsCollection.h:161
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition InclusiveKinematicsCollection.cc:120
const_iterator end() const
Definition InclusiveKinematicsCollection.h:258
reverse_iterator rbegin()
Definition InclusiveKinematicsCollection.h:265
iterator begin()
Definition InclusiveKinematicsCollection.h:246
InclusiveKinematicsMutableCollectionIterator iterator
Definition InclusiveKinematicsCollection.h:142
iterator end()
Definition InclusiveKinematicsCollection.h:255
MutableInclusiveKinematics mutable_type
Definition InclusiveKinematicsCollection.h:140
static constexpr std::string_view valueTypeName
Definition InclusiveKinematicsCollection.h:160
bool isSubsetCollection() const final
Definition InclusiveKinematicsCollection.h:197
InclusiveKinematics at(std::size_t index) const
Returns the const object of given index.
Definition InclusiveKinematicsCollection.cc:39
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition InclusiveKinematicsCollection.h:193
ptrdiff_t difference_type
Definition InclusiveKinematicsCollection.h:143
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition InclusiveKinematicsCollection.cc:215
std::size_t max_size() const final
maximal number of elements in the collection
Definition InclusiveKinematicsCollection.cc:55
const_reverse_iterator crend() const
Definition InclusiveKinematicsCollection.h:280
static constexpr std::string_view typeName
Definition InclusiveKinematicsCollection.h:159
Definition InclusiveKinematicsCollection.h:36
InclusiveKinematicsCollectionIterator & operator-=(difference_type n)
Definition InclusiveKinematicsCollection.cc:364
InclusiveKinematicsCollectionIterator(const InclusiveKinematicsCollectionIterator &)=default
reference operator[](difference_type n) const
Definition InclusiveKinematicsCollection.cc:375
pointer operator->()
Definition InclusiveKinematicsCollection.cc:322
InclusiveKinematicsCollectionIterator & operator+=(difference_type n)
Definition InclusiveKinematicsCollection.cc:349
InclusiveKinematicsCollectionIterator & operator=(const InclusiveKinematicsCollectionIterator &)=default
InclusiveKinematicsCollectionIterator operator+(difference_type n) const
Definition InclusiveKinematicsCollection.cc:354
InclusiveKinematicsCollectionIterator(size_t index, const InclusiveKinematicsObjPointerContainer *collection)
Definition InclusiveKinematicsCollection.h:47
InclusiveKinematics value_type
Definition InclusiveKinematicsCollection.h:38
InclusiveKinematicsCollectionIterator(InclusiveKinematicsCollectionIterator &&)=default
InclusiveKinematicsCollectionIterator & operator++()
Definition InclusiveKinematicsCollection.cc:327
InclusiveKinematicsCollectionIterator & operator--()
Definition InclusiveKinematicsCollection.cc:338
reference operator*() const
Definition InclusiveKinematicsCollection.cc:318
ptrdiff_t difference_type
Definition InclusiveKinematicsCollection.h:39
std::random_access_iterator_tag iterator_concept
Definition InclusiveKinematicsCollection.h:45
bool operator==(const InclusiveKinematicsCollectionIterator &x) const
Definition InclusiveKinematicsCollection.h:60
InclusiveKinematics * pointer
Definition InclusiveKinematicsCollection.h:41
InclusiveKinematicsCollectionIterator operator-(difference_type n) const
Definition InclusiveKinematicsCollection.cc:369
std::input_iterator_tag iterator_category
Definition InclusiveKinematicsCollection.h:42
InclusiveKinematics reference
Definition InclusiveKinematicsCollection.h:40
InclusiveKinematicsCollectionIterator & operator=(InclusiveKinematicsCollectionIterator &&)=default
auto operator<=>(const InclusiveKinematicsCollectionIterator &other) const
Definition InclusiveKinematicsCollection.h:56
Definition InclusiveKinematics.h:42
Definition InclusiveKinematicsCollection.h:85
InclusiveKinematicsMutableCollectionIterator operator+(difference_type n) const
Definition InclusiveKinematicsCollection.cc:421
InclusiveKinematicsMutableCollectionIterator & operator++()
Definition InclusiveKinematicsCollection.cc:394
reference operator[](difference_type n) const
Definition InclusiveKinematicsCollection.cc:442
InclusiveKinematicsMutableCollectionIterator(InclusiveKinematicsMutableCollectionIterator &&)=default
InclusiveKinematicsMutableCollectionIterator & operator--()
Definition InclusiveKinematicsCollection.cc:405
ptrdiff_t difference_type
Definition InclusiveKinematicsCollection.h:88
MutableInclusiveKinematics reference
Definition InclusiveKinematicsCollection.h:89
auto operator<=>(const InclusiveKinematicsMutableCollectionIterator &other) const
Definition InclusiveKinematicsCollection.h:105
std::random_access_iterator_tag iterator_concept
Definition InclusiveKinematicsCollection.h:94
InclusiveKinematics value_type
Definition InclusiveKinematicsCollection.h:87
pointer operator->()
Definition InclusiveKinematicsCollection.cc:389
InclusiveKinematicsMutableCollectionIterator & operator+=(difference_type n)
Definition InclusiveKinematicsCollection.cc:416
InclusiveKinematicsMutableCollectionIterator & operator=(InclusiveKinematicsMutableCollectionIterator &&)=default
bool operator==(const InclusiveKinematicsMutableCollectionIterator &x) const
Definition InclusiveKinematicsCollection.h:109
reference operator*() const
Definition InclusiveKinematicsCollection.cc:385
MutableInclusiveKinematics * pointer
Definition InclusiveKinematicsCollection.h:90
InclusiveKinematicsMutableCollectionIterator & operator-=(difference_type n)
Definition InclusiveKinematicsCollection.cc:431
InclusiveKinematicsMutableCollectionIterator operator-(difference_type n) const
Definition InclusiveKinematicsCollection.cc:436
InclusiveKinematicsMutableCollectionIterator(size_t index, const InclusiveKinematicsObjPointerContainer *collection)
Definition InclusiveKinematicsCollection.h:96
std::input_iterator_tag iterator_category
Definition InclusiveKinematicsCollection.h:91
InclusiveKinematicsMutableCollectionIterator & operator=(const InclusiveKinematicsMutableCollectionIterator &)=default
InclusiveKinematicsMutableCollectionIterator(const InclusiveKinematicsMutableCollectionIterator &)=default
Definition InclusiveKinematicsObj.h:21
Definition MutableInclusiveKinematics.h:34
Definition CalorimeterHit.cc:17
std::deque< InclusiveKinematicsObj * > InclusiveKinematicsObjPointerContainer
Definition InclusiveKinematicsCollectionData.h:23
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:31