EDM4eic
EIC data model
Loading...
Searching...
No Matches
ClusterCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_ClusterCollection_H
4#define EDM4EIC_ClusterCollection_H
5
6// datamodel specific includes
7#include "edm4eic/Cluster.h"
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;
41 using pointer = Cluster*;
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 ClusterCollectionIterator(size_t index, const ClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ClusterObj>{nullptr}), m_collection(collection) {}
49
55
56 auto operator<=>(const ClusterCollectionIterator& other) const {
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 Cluster m_object { podio::utils::MaybeSharedPtr<ClusterObj>{nullptr} };
81 const ClusterObjPointerContainer* 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 ClusterMutableCollectionIterator(size_t index, const ClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ClusterObj>{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 MutableCluster m_object { podio::utils::MaybeSharedPtr<ClusterObj>{nullptr} };
130 const ClusterObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class ClusterCollection : 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
149 ClusterCollection(ClusterCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// ClusterCollection(ClusterVector* data, uint32_t collectionID);
157 ~ClusterCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::ClusterCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::Cluster";
161 constexpr static std::string_view dataTypeName = "edm4eic::ClusterData";
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 ClusterCollection* operator->() { return static_cast<ClusterCollection*>(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 MutableCluster 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 Cluster operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableCluster operator[](std::size_t index);
207 /// Returns the const object of given index
208 Cluster at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableCluster at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableCluster& object);
215 /// Append an object to the (subset) collection
216 void push_back(const Cluster& 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] (ClusterObj* 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<std::int32_t> type(const size_t nElem = 0) const;
286 std::vector<float> energy(const size_t nElem = 0) const;
287 std::vector<float> energyError(const size_t nElem = 0) const;
288 std::vector<float> time(const size_t nElem = 0) const;
289 std::vector<float> timeError(const size_t nElem = 0) const;
290 std::vector<std::uint32_t> nhits(const size_t nElem = 0) const;
291 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
292 std::vector<edm4eic::Cov3f> positionError(const size_t nElem = 0) const;
293 std::vector<float> intrinsicTheta(const size_t nElem = 0) const;
294 std::vector<float> intrinsicPhi(const size_t nElem = 0) const;
295 std::vector<edm4eic::Cov2f> intrinsicDirectionError(const size_t nElem = 0) const;
296
297private:
298 // For setReferences, we need to give our own CollectionData access to our
299 // private entries. Otherwise we would need to expose a public member function
300 // that gives access to the Obj* which is definitely not what we want
302
303 bool m_isValid{false};
304 mutable bool m_isPrepared{false};
305 bool m_isSubsetColl{false};
306 uint32_t m_collectionID{0};
307 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
308 mutable ClusterCollectionData m_storage{};
309};
310
311std::ostream& operator<<(std::ostream& o, const ClusterCollection& v);
312
313template<typename... Args>
315 if (m_isSubsetColl) {
316 throw std::logic_error("Cannot create new elements on a subset collection");
317 }
318 const int size = m_storage.entries.size();
319 auto obj = new ClusterObj({size, m_collectionID}, {std::forward<Args>(args)...});
320 m_storage.entries.push_back(obj);
321
322 // Need to initialize the relation vectors manually for the {ObjectID, ClusterData} constructor
323 obj->m_clusters = new std::vector<edm4eic::Cluster>();
324 obj->m_hits = new std::vector<edm4eic::CalorimeterHit>();
325 obj->m_particleIDs = new std::vector<edm4hep::ParticleID>();
326 obj->m_shapeParameters = new std::vector<float>();
327 obj->m_hitContributions = new std::vector<float>();
328 obj->m_subdetectorEnergies = new std::vector<float>();
329 m_storage.createRelations(obj);
330 return MutableCluster(podio::utils::MaybeSharedPtr(obj));
331}
332
333#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
334void to_json(nlohmann::json& j, const ClusterCollection& collection);
335#endif
336
337} // namespace edm4eic
338
339
340#endif
Definition ClusterCollectionData.h:32
Definition ClusterCollection.h:137
bool isSubsetCollection() const final
Definition ClusterCollection.h:197
static constexpr std::string_view dataTypeName
Definition ClusterCollection.h:161
const_iterator cend() const
Definition ClusterCollection.h:261
void prepareAfterRead() final
Definition ClusterCollection.cc:108
void clear() final
Definition ClusterCollection.cc:94
std::size_t max_size() const final
maximal number of elements in the collection
Definition ClusterCollection.cc:57
const_reverse_iterator rend() const
Definition ClusterCollection.h:277
ptrdiff_t difference_type
Definition ClusterCollection.h:143
reverse_iterator rend()
Definition ClusterCollection.h:274
ClusterCollectionIterator const_iterator
Definition ClusterCollection.h:141
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition ClusterCollection.h:145
bool empty() const final
Is the collection empty.
Definition ClusterCollection.cc:67
Cluster at(std::size_t index) const
Returns the const object of given index.
Definition ClusterCollection.cc:41
ClusterCollection & operator=(ClusterCollection &&)=default
std::size_t size() const final
number of elements in the collection
Definition ClusterCollection.cc:53
void setID(uint32_t ID) final
Definition ClusterCollection.h:225
ClusterCollection()
Definition ClusterCollection.cc:26
const_iterator cbegin() const
Definition ClusterCollection.h:252
const_iterator begin() const
Definition ClusterCollection.h:249
static constexpr std::string_view valueTypeName
Definition ClusterCollection.h:160
ClusterCollection(const ClusterCollection &)=delete
MutableCluster mutable_type
Definition ClusterCollection.h:140
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition ClusterCollection.h:193
const std::string_view getTypeName() const final
fully qualified type name
Definition ClusterCollection.h:189
iterator end()
Definition ClusterCollection.h:255
friend class ClusterCollectionData
Definition ClusterCollection.h:301
const_iterator end() const
Definition ClusterCollection.h:258
ClusterCollection & operator=(const ClusterCollection &)=delete
ClusterCollection(ClusterCollection &&)=default
MutableCluster create()
Append a new object to the collection, and return this object.
Definition ClusterCollection.cc:82
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition ClusterCollection.cc:123
static constexpr std::string_view typeName
Definition ClusterCollection.h:159
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition ClusterCollection.h:191
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition ClusterCollection.cc:160
const_reverse_iterator rbegin() const
Definition ClusterCollection.h:268
const_reverse_iterator crbegin() const
Definition ClusterCollection.h:271
void push_back(const MutableCluster &object)
Append object to the collection.
Definition ClusterCollection.cc:127
reverse_iterator rbegin()
Definition ClusterCollection.h:265
ClusterMutableCollectionIterator iterator
Definition ClusterCollection.h:142
bool isValid() const final
Definition ClusterCollection.h:239
void setSubsetCollection(bool setSubset=true) final
Definition ClusterCollection.cc:71
Cluster value_type
Definition ClusterCollection.h:139
size_t size_type
Definition ClusterCollection.h:144
iterator begin()
Definition ClusterCollection.h:246
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition ClusterCollection.cc:279
const_reverse_iterator crend() const
Definition ClusterCollection.h:280
~ClusterCollection() override
Definition ClusterCollection.cc:32
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition ClusterCollection.cc:583
void prepareForWrite() const final
Definition ClusterCollection.cc:99
uint32_t getID() const final
Definition ClusterCollection.h:235
std::reverse_iterator< iterator > reverse_iterator
Definition ClusterCollection.h:146
Definition ClusterCollection.h:36
ClusterCollectionIterator & operator+=(difference_type n)
Definition ClusterCollection.cc:422
ClusterCollectionIterator & operator=(ClusterCollectionIterator &&)=default
Cluster value_type
Definition ClusterCollection.h:38
ptrdiff_t difference_type
Definition ClusterCollection.h:39
std::input_iterator_tag iterator_category
Definition ClusterCollection.h:42
ClusterCollectionIterator(const ClusterCollectionIterator &)=default
ClusterCollectionIterator & operator=(const ClusterCollectionIterator &)=default
bool operator==(const ClusterCollectionIterator &x) const
Definition ClusterCollection.h:60
reference operator[](difference_type n) const
Definition ClusterCollection.cc:448
ClusterCollectionIterator & operator-=(difference_type n)
Definition ClusterCollection.cc:437
ClusterCollectionIterator & operator--()
Definition ClusterCollection.cc:411
Cluster * pointer
Definition ClusterCollection.h:41
std::random_access_iterator_tag iterator_concept
Definition ClusterCollection.h:45
auto operator<=>(const ClusterCollectionIterator &other) const
Definition ClusterCollection.h:56
ClusterCollectionIterator operator+(difference_type n) const
Definition ClusterCollection.cc:427
Cluster reference
Definition ClusterCollection.h:40
ClusterCollectionIterator(ClusterCollectionIterator &&)=default
ClusterCollectionIterator operator-(difference_type n) const
Definition ClusterCollection.cc:442
pointer operator->()
Definition ClusterCollection.cc:395
ClusterCollectionIterator(size_t index, const ClusterObjPointerContainer *collection)
Definition ClusterCollection.h:47
ClusterCollectionIterator & operator++()
Definition ClusterCollection.cc:400
reference operator*() const
Definition ClusterCollection.cc:391
Definition Cluster.h:48
Definition ClusterCollection.h:85
auto operator<=>(const ClusterMutableCollectionIterator &other) const
Definition ClusterCollection.h:105
pointer operator->()
Definition ClusterCollection.cc:462
ClusterMutableCollectionIterator(size_t index, const ClusterObjPointerContainer *collection)
Definition ClusterCollection.h:96
ptrdiff_t difference_type
Definition ClusterCollection.h:88
ClusterMutableCollectionIterator & operator=(const ClusterMutableCollectionIterator &)=default
ClusterMutableCollectionIterator & operator-=(difference_type n)
Definition ClusterCollection.cc:504
MutableCluster * pointer
Definition ClusterCollection.h:90
std::random_access_iterator_tag iterator_concept
Definition ClusterCollection.h:94
bool operator==(const ClusterMutableCollectionIterator &x) const
Definition ClusterCollection.h:109
reference operator*() const
Definition ClusterCollection.cc:458
std::input_iterator_tag iterator_category
Definition ClusterCollection.h:91
MutableCluster reference
Definition ClusterCollection.h:89
ClusterMutableCollectionIterator operator+(difference_type n) const
Definition ClusterCollection.cc:494
ClusterMutableCollectionIterator & operator+=(difference_type n)
Definition ClusterCollection.cc:489
ClusterMutableCollectionIterator operator-(difference_type n) const
Definition ClusterCollection.cc:509
reference operator[](difference_type n) const
Definition ClusterCollection.cc:515
ClusterMutableCollectionIterator & operator++()
Definition ClusterCollection.cc:467
ClusterMutableCollectionIterator & operator=(ClusterMutableCollectionIterator &&)=default
Cluster value_type
Definition ClusterCollection.h:87
ClusterMutableCollectionIterator(const ClusterMutableCollectionIterator &)=default
ClusterMutableCollectionIterator(ClusterMutableCollectionIterator &&)=default
ClusterMutableCollectionIterator & operator--()
Definition ClusterCollection.cc:478
Definition ClusterObj.h:21
std::vector< edm4eic::Cluster > * m_clusters
Definition ClusterObj.h:37
Definition MutableCluster.h:40
Definition CalorimeterHit.cc:17
std::deque< ClusterObj * > ClusterObjPointerContainer
Definition ClusterCollectionData.h:24
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:31