EDM4eic
EIC data model
Loading...
Searching...
No Matches
HadronicFinalStateCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_HadronicFinalStateCollection_H
4#define EDM4EIC_HadronicFinalStateCollection_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 HadronicFinalStateCollectionIterator(size_t index, const HadronicFinalStateObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<HadronicFinalStateObj>{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 HadronicFinalState m_object { podio::utils::MaybeSharedPtr<HadronicFinalStateObj>{nullptr} };
81 const HadronicFinalStateObjPointerContainer* 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 HadronicFinalStateMutableCollectionIterator(size_t index, const HadronicFinalStateObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<HadronicFinalStateObj>{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 MutableHadronicFinalState m_object { podio::utils::MaybeSharedPtr<HadronicFinalStateObj>{nullptr} };
130 const HadronicFinalStateObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class HadronicFinalStateCollection : 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// HadronicFinalStateCollection(HadronicFinalStateVector* data, uint32_t collectionID);
158
159 constexpr static std::string_view typeName = "edm4eic::HadronicFinalStateCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::HadronicFinalState";
161 constexpr static std::string_view dataTypeName = "edm4eic::HadronicFinalStateData";
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 HadronicFinalStateCollection* operator->() { return static_cast<HadronicFinalStateCollection*>(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 MutableHadronicFinalState 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 HadronicFinalState operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableHadronicFinalState operator[](std::size_t index);
207 /// Returns the const object of given index
208 HadronicFinalState at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableHadronicFinalState at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableHadronicFinalState& object);
215 /// Append an object to the (subset) collection
216 void push_back(const HadronicFinalState& 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] (HadronicFinalStateObj* 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> sigma(const size_t nElem = 0) const;
286 std::vector<float> pT(const size_t nElem = 0) const;
287 std::vector<float> gamma(const size_t nElem = 0) const;
288
289private:
290 // For setReferences, we need to give our own CollectionData access to our
291 // private entries. Otherwise we would need to expose a public member function
292 // that gives access to the Obj* which is definitely not what we want
294
295 bool m_isValid{false};
296 mutable bool m_isPrepared{false};
297 bool m_isSubsetColl{false};
298 uint32_t m_collectionID{0};
299 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
300 mutable HadronicFinalStateCollectionData m_storage{};
301};
302
303std::ostream& operator<<(std::ostream& o, const HadronicFinalStateCollection& v);
304
305template<typename... Args>
307 if (m_isSubsetColl) {
308 throw std::logic_error("Cannot create new elements on a subset collection");
309 }
310 const int size = m_storage.entries.size();
311 auto obj = new HadronicFinalStateObj({size, m_collectionID}, {std::forward<Args>(args)...});
312 m_storage.entries.push_back(obj);
313
314 // Need to initialize the relation vectors manually for the {ObjectID, HadronicFinalStateData} constructor
315 obj->m_hadrons = new std::vector<edm4eic::ReconstructedParticle>();
316 m_storage.createRelations(obj);
317 return MutableHadronicFinalState(podio::utils::MaybeSharedPtr(obj));
318}
319
320#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
321void to_json(nlohmann::json& j, const HadronicFinalStateCollection& collection);
322#endif
323
324} // namespace edm4eic
325
326
327#endif
Definition HadronicFinalStateCollectionData.h:31
Definition HadronicFinalStateCollection.h:137
const_reverse_iterator crend() const
Definition HadronicFinalStateCollection.h:280
size_t size_type
Definition HadronicFinalStateCollection.h:144
void clear() final
Definition HadronicFinalStateCollection.cc:92
void setSubsetCollection(bool setSubset=true) final
Definition HadronicFinalStateCollection.cc:69
HadronicFinalStateCollectionIterator const_iterator
Definition HadronicFinalStateCollection.h:141
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition HadronicFinalStateCollection.h:193
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition HadronicFinalStateCollection.cc:158
HadronicFinalStateCollection(const HadronicFinalStateCollection &)=delete
std::reverse_iterator< iterator > reverse_iterator
Definition HadronicFinalStateCollection.h:146
ptrdiff_t difference_type
Definition HadronicFinalStateCollection.h:143
iterator begin()
Definition HadronicFinalStateCollection.h:246
const_reverse_iterator crbegin() const
Definition HadronicFinalStateCollection.h:271
friend class HadronicFinalStateCollectionData
Definition HadronicFinalStateCollection.h:293
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition HadronicFinalStateCollection.cc:459
HadronicFinalStateCollection & operator=(HadronicFinalStateCollection &&)=default
MutableHadronicFinalState mutable_type
Definition HadronicFinalStateCollection.h:140
HadronicFinalStateCollection(HadronicFinalStateCollection &&)=default
void setID(uint32_t ID) final
Definition HadronicFinalStateCollection.h:225
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition HadronicFinalStateCollection.cc:121
bool empty() const final
Is the collection empty.
Definition HadronicFinalStateCollection.cc:65
HadronicFinalState at(std::size_t index) const
Returns the const object of given index.
Definition HadronicFinalStateCollection.cc:39
bool isValid() const final
Definition HadronicFinalStateCollection.h:239
const_iterator cbegin() const
Definition HadronicFinalStateCollection.h:252
const_reverse_iterator rbegin() const
Definition HadronicFinalStateCollection.h:268
uint32_t getID() const final
Definition HadronicFinalStateCollection.h:235
std::size_t size() const final
number of elements in the collection
Definition HadronicFinalStateCollection.cc:51
HadronicFinalState value_type
Definition HadronicFinalStateCollection.h:139
MutableHadronicFinalState create()
Append a new object to the collection, and return this object.
Definition HadronicFinalStateCollection.cc:80
HadronicFinalStateCollection()
Definition HadronicFinalStateCollection.cc:24
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition HadronicFinalStateCollection.cc:197
void prepareForWrite() const final
Definition HadronicFinalStateCollection.cc:97
const_iterator begin() const
Definition HadronicFinalStateCollection.h:249
iterator end()
Definition HadronicFinalStateCollection.h:255
static constexpr std::string_view typeName
Definition HadronicFinalStateCollection.h:159
const_iterator cend() const
Definition HadronicFinalStateCollection.h:261
HadronicFinalStateMutableCollectionIterator iterator
Definition HadronicFinalStateCollection.h:142
static constexpr std::string_view dataTypeName
Definition HadronicFinalStateCollection.h:161
void prepareAfterRead() final
Definition HadronicFinalStateCollection.cc:106
const_reverse_iterator rend() const
Definition HadronicFinalStateCollection.h:277
const std::string_view getTypeName() const final
fully qualified type name
Definition HadronicFinalStateCollection.h:189
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition HadronicFinalStateCollection.h:191
std::size_t max_size() const final
maximal number of elements in the collection
Definition HadronicFinalStateCollection.cc:55
static constexpr std::string_view valueTypeName
Definition HadronicFinalStateCollection.h:160
~HadronicFinalStateCollection() override
Definition HadronicFinalStateCollection.cc:30
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition HadronicFinalStateCollection.h:145
void push_back(const MutableHadronicFinalState &object)
Append object to the collection.
Definition HadronicFinalStateCollection.cc:125
reverse_iterator rend()
Definition HadronicFinalStateCollection.h:274
const_iterator end() const
Definition HadronicFinalStateCollection.h:258
bool isSubsetCollection() const final
Definition HadronicFinalStateCollection.h:197
HadronicFinalStateCollection & operator=(const HadronicFinalStateCollection &)=delete
reverse_iterator rbegin()
Definition HadronicFinalStateCollection.h:265
Definition HadronicFinalStateCollection.h:36
HadronicFinalStateCollectionIterator(HadronicFinalStateCollectionIterator &&)=default
reference operator[](difference_type n) const
Definition HadronicFinalStateCollection.cc:357
HadronicFinalStateCollectionIterator(size_t index, const HadronicFinalStateObjPointerContainer *collection)
Definition HadronicFinalStateCollection.h:47
HadronicFinalStateCollectionIterator & operator++()
Definition HadronicFinalStateCollection.cc:309
HadronicFinalStateCollectionIterator & operator--()
Definition HadronicFinalStateCollection.cc:320
HadronicFinalState reference
Definition HadronicFinalStateCollection.h:40
reference operator*() const
Definition HadronicFinalStateCollection.cc:300
ptrdiff_t difference_type
Definition HadronicFinalStateCollection.h:39
auto operator<=>(const HadronicFinalStateCollectionIterator &other) const
Definition HadronicFinalStateCollection.h:56
HadronicFinalState value_type
Definition HadronicFinalStateCollection.h:38
bool operator==(const HadronicFinalStateCollectionIterator &x) const
Definition HadronicFinalStateCollection.h:60
HadronicFinalStateCollectionIterator & operator=(HadronicFinalStateCollectionIterator &&)=default
HadronicFinalStateCollectionIterator operator-(difference_type n) const
Definition HadronicFinalStateCollection.cc:351
std::random_access_iterator_tag iterator_concept
Definition HadronicFinalStateCollection.h:45
HadronicFinalStateCollectionIterator & operator=(const HadronicFinalStateCollectionIterator &)=default
HadronicFinalStateCollectionIterator & operator-=(difference_type n)
Definition HadronicFinalStateCollection.cc:346
HadronicFinalStateCollectionIterator & operator+=(difference_type n)
Definition HadronicFinalStateCollection.cc:331
HadronicFinalStateCollectionIterator operator+(difference_type n) const
Definition HadronicFinalStateCollection.cc:336
HadronicFinalStateCollectionIterator(const HadronicFinalStateCollectionIterator &)=default
std::input_iterator_tag iterator_category
Definition HadronicFinalStateCollection.h:42
pointer operator->()
Definition HadronicFinalStateCollection.cc:304
HadronicFinalState * pointer
Definition HadronicFinalStateCollection.h:41
Definition HadronicFinalState.h:43
Definition HadronicFinalStateCollection.h:85
HadronicFinalStateMutableCollectionIterator(size_t index, const HadronicFinalStateObjPointerContainer *collection)
Definition HadronicFinalStateCollection.h:96
HadronicFinalStateMutableCollectionIterator & operator=(const HadronicFinalStateMutableCollectionIterator &)=default
HadronicFinalStateMutableCollectionIterator operator-(difference_type n) const
Definition HadronicFinalStateCollection.cc:418
HadronicFinalStateMutableCollectionIterator & operator=(HadronicFinalStateMutableCollectionIterator &&)=default
HadronicFinalStateMutableCollectionIterator & operator++()
Definition HadronicFinalStateCollection.cc:376
bool operator==(const HadronicFinalStateMutableCollectionIterator &x) const
Definition HadronicFinalStateCollection.h:109
HadronicFinalStateMutableCollectionIterator(HadronicFinalStateMutableCollectionIterator &&)=default
HadronicFinalStateMutableCollectionIterator & operator--()
Definition HadronicFinalStateCollection.cc:387
HadronicFinalState value_type
Definition HadronicFinalStateCollection.h:87
MutableHadronicFinalState * pointer
Definition HadronicFinalStateCollection.h:90
auto operator<=>(const HadronicFinalStateMutableCollectionIterator &other) const
Definition HadronicFinalStateCollection.h:105
HadronicFinalStateMutableCollectionIterator & operator-=(difference_type n)
Definition HadronicFinalStateCollection.cc:413
std::input_iterator_tag iterator_category
Definition HadronicFinalStateCollection.h:91
std::random_access_iterator_tag iterator_concept
Definition HadronicFinalStateCollection.h:94
reference operator[](difference_type n) const
Definition HadronicFinalStateCollection.cc:424
reference operator*() const
Definition HadronicFinalStateCollection.cc:367
HadronicFinalStateMutableCollectionIterator operator+(difference_type n) const
Definition HadronicFinalStateCollection.cc:403
ptrdiff_t difference_type
Definition HadronicFinalStateCollection.h:88
HadronicFinalStateMutableCollectionIterator(const HadronicFinalStateMutableCollectionIterator &)=default
MutableHadronicFinalState reference
Definition HadronicFinalStateCollection.h:89
pointer operator->()
Definition HadronicFinalStateCollection.cc:371
HadronicFinalStateMutableCollectionIterator & operator+=(difference_type n)
Definition HadronicFinalStateCollection.cc:398
Definition HadronicFinalStateObj.h:20
std::vector< edm4eic::ReconstructedParticle > * m_hadrons
Definition HadronicFinalStateObj.h:36
Definition MutableHadronicFinalState.h:35
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< HadronicFinalStateObj * > HadronicFinalStateObjPointerContainer
Definition HadronicFinalStateCollectionData.h:23
Definition CalorimeterHit.h:31