EDM4eic
EIC data model
Loading...
Searching...
No Matches
RingImageCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_RingImageCollection_H
4#define EDM4EIC_RingImageCollection_H
5
6// datamodel specific includes
7#include "edm4eic/RingImage.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;
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 RingImageCollectionIterator(size_t index, const RingImageObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RingImageObj>{nullptr}), m_collection(collection) {}
49
55
56 auto operator<=>(const RingImageCollectionIterator& 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 RingImage m_object { podio::utils::MaybeSharedPtr<RingImageObj>{nullptr} };
81 const RingImageObjPointerContainer* 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 RingImageMutableCollectionIterator(size_t index, const RingImageObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RingImageObj>{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 MutableRingImage m_object { podio::utils::MaybeSharedPtr<RingImageObj>{nullptr} };
130 const RingImageObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class RingImageCollection : 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 RingImageCollection(RingImageCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// RingImageCollection(RingImageVector* data, uint32_t collectionID);
157 ~RingImageCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::RingImageCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::RingImage";
161 constexpr static std::string_view dataTypeName = "edm4eic::RingImageData";
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 RingImageCollection* operator->() { return static_cast<RingImageCollection*>(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 MutableRingImage 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 RingImage operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableRingImage operator[](std::size_t index);
207 /// Returns the const object of given index
208 RingImage at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableRingImage at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableRingImage& object);
215 /// Append an object to the (subset) collection
216 void push_back(const RingImage& 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] (RingImageObj* 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> npe(const size_t nElem = 0) const;
286 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
287 std::vector<edm4hep::Vector3f> positionError(const size_t nElem = 0) const;
288 std::vector<float> theta(const size_t nElem = 0) const;
289 std::vector<float> thetaError(const size_t nElem = 0) const;
290 std::vector<float> radius(const size_t nElem = 0) const;
291 std::vector<float> radiusError(const size_t nElem = 0) const;
292
293private:
294 // For setReferences, we need to give our own CollectionData access to our
295 // private entries. Otherwise we would need to expose a public member function
296 // that gives access to the Obj* which is definitely not what we want
298
299 bool m_isValid{false};
300 mutable bool m_isPrepared{false};
301 bool m_isSubsetColl{false};
302 uint32_t m_collectionID{0};
303 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
304 mutable RingImageCollectionData m_storage{};
305};
306
307std::ostream& operator<<(std::ostream& o, const RingImageCollection& v);
308
309template<typename... Args>
311 if (m_isSubsetColl) {
312 throw std::logic_error("Cannot create new elements on a subset collection");
313 }
314 const int size = m_storage.entries.size();
315 auto obj = new RingImageObj({size, m_collectionID}, {std::forward<Args>(args)...});
316 m_storage.entries.push_back(obj);
317
318 return MutableRingImage(podio::utils::MaybeSharedPtr(obj));
319}
320
321#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
322void to_json(nlohmann::json& j, const RingImageCollection& collection);
323#endif
324
325} // namespace edm4eic
326
327
328#endif
Definition MutableRingImage.h:33
Definition RingImageCollectionData.h:30
Definition RingImageCollection.h:137
reverse_iterator rend()
Definition RingImageCollection.h:274
ptrdiff_t difference_type
Definition RingImageCollection.h:143
uint32_t getID() const final
Definition RingImageCollection.h:235
RingImage value_type
Definition RingImageCollection.h:139
const_reverse_iterator rbegin() const
Definition RingImageCollection.h:268
RingImageCollection()
Definition RingImageCollection.cc:23
const_reverse_iterator crbegin() const
Definition RingImageCollection.h:271
const_reverse_iterator crend() const
Definition RingImageCollection.h:280
RingImage at(std::size_t index) const
Returns the const object of given index.
Definition RingImageCollection.cc:38
RingImageCollection(RingImageCollection &&)=default
void setID(uint32_t ID) final
Definition RingImageCollection.h:225
const_iterator begin() const
Definition RingImageCollection.h:249
RingImageMutableCollectionIterator iterator
Definition RingImageCollection.h:142
MutableRingImage create()
Append a new object to the collection, and return this object.
Definition RingImageCollection.cc:79
std::size_t size() const final
number of elements in the collection
Definition RingImageCollection.cc:50
RingImageCollection & operator=(const RingImageCollection &)=delete
std::reverse_iterator< iterator > reverse_iterator
Definition RingImageCollection.h:146
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition RingImageCollection.cc:119
bool empty() const final
Is the collection empty.
Definition RingImageCollection.cc:64
static constexpr std::string_view dataTypeName
Definition RingImageCollection.h:161
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition RingImageCollection.cc:495
void prepareAfterRead() final
Definition RingImageCollection.cc:104
reverse_iterator rbegin()
Definition RingImageCollection.h:265
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition RingImageCollection.h:145
const_reverse_iterator rend() const
Definition RingImageCollection.h:277
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition RingImageCollection.h:191
iterator end()
Definition RingImageCollection.h:255
void clear() final
Definition RingImageCollection.cc:90
iterator begin()
Definition RingImageCollection.h:246
void setSubsetCollection(bool setSubset=true) final
Definition RingImageCollection.cc:68
size_t size_type
Definition RingImageCollection.h:144
const_iterator cend() const
Definition RingImageCollection.h:261
RingImageCollectionIterator const_iterator
Definition RingImageCollection.h:141
friend class RingImageCollectionData
Definition RingImageCollection.h:297
bool isValid() const final
Definition RingImageCollection.h:239
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition RingImageCollection.cc:234
static constexpr std::string_view valueTypeName
Definition RingImageCollection.h:160
RingImageCollection(const RingImageCollection &)=delete
bool isSubsetCollection() const final
Definition RingImageCollection.h:197
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition RingImageCollection.cc:155
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition RingImageCollection.h:193
void prepareForWrite() const final
Definition RingImageCollection.cc:95
static constexpr std::string_view typeName
Definition RingImageCollection.h:159
MutableRingImage mutable_type
Definition RingImageCollection.h:140
const std::string_view getTypeName() const final
fully qualified type name
Definition RingImageCollection.h:189
RingImageCollection & operator=(RingImageCollection &&)=default
void push_back(const MutableRingImage &object)
Append object to the collection.
Definition RingImageCollection.cc:123
~RingImageCollection() override
Definition RingImageCollection.cc:29
std::size_t max_size() const final
maximal number of elements in the collection
Definition RingImageCollection.cc:54
const_iterator cbegin() const
Definition RingImageCollection.h:252
const_iterator end() const
Definition RingImageCollection.h:258
Definition RingImageCollection.h:36
RingImageCollectionIterator & operator+=(difference_type n)
Definition RingImageCollection.cc:368
RingImageCollectionIterator & operator=(RingImageCollectionIterator &&)=default
std::random_access_iterator_tag iterator_concept
Definition RingImageCollection.h:45
RingImageCollectionIterator & operator=(const RingImageCollectionIterator &)=default
reference operator*() const
Definition RingImageCollection.cc:337
RingImage value_type
Definition RingImageCollection.h:38
RingImageCollectionIterator & operator-=(difference_type n)
Definition RingImageCollection.cc:383
pointer operator->()
Definition RingImageCollection.cc:341
bool operator==(const RingImageCollectionIterator &x) const
Definition RingImageCollection.h:60
auto operator<=>(const RingImageCollectionIterator &other) const
Definition RingImageCollection.h:56
RingImageCollectionIterator(size_t index, const RingImageObjPointerContainer *collection)
Definition RingImageCollection.h:47
RingImageCollectionIterator & operator++()
Definition RingImageCollection.cc:346
reference operator[](difference_type n) const
Definition RingImageCollection.cc:394
RingImageCollectionIterator operator-(difference_type n) const
Definition RingImageCollection.cc:388
RingImageCollectionIterator operator+(difference_type n) const
Definition RingImageCollection.cc:373
RingImage reference
Definition RingImageCollection.h:40
RingImage * pointer
Definition RingImageCollection.h:41
ptrdiff_t difference_type
Definition RingImageCollection.h:39
std::input_iterator_tag iterator_category
Definition RingImageCollection.h:42
RingImageCollectionIterator(const RingImageCollectionIterator &)=default
RingImageCollectionIterator(RingImageCollectionIterator &&)=default
RingImageCollectionIterator & operator--()
Definition RingImageCollection.cc:357
Definition RingImage.h:41
Definition RingImageCollection.h:85
MutableRingImage reference
Definition RingImageCollection.h:89
RingImageMutableCollectionIterator & operator=(RingImageMutableCollectionIterator &&)=default
RingImageMutableCollectionIterator & operator+=(difference_type n)
Definition RingImageCollection.cc:435
RingImageMutableCollectionIterator operator+(difference_type n) const
Definition RingImageCollection.cc:440
bool operator==(const RingImageMutableCollectionIterator &x) const
Definition RingImageCollection.h:109
ptrdiff_t difference_type
Definition RingImageCollection.h:88
reference operator[](difference_type n) const
Definition RingImageCollection.cc:461
std::input_iterator_tag iterator_category
Definition RingImageCollection.h:91
reference operator*() const
Definition RingImageCollection.cc:404
RingImageMutableCollectionIterator(RingImageMutableCollectionIterator &&)=default
MutableRingImage * pointer
Definition RingImageCollection.h:90
auto operator<=>(const RingImageMutableCollectionIterator &other) const
Definition RingImageCollection.h:105
RingImageMutableCollectionIterator & operator++()
Definition RingImageCollection.cc:413
RingImageMutableCollectionIterator(const RingImageMutableCollectionIterator &)=default
std::random_access_iterator_tag iterator_concept
Definition RingImageCollection.h:94
RingImage value_type
Definition RingImageCollection.h:87
RingImageMutableCollectionIterator & operator--()
Definition RingImageCollection.cc:424
pointer operator->()
Definition RingImageCollection.cc:408
RingImageMutableCollectionIterator operator-(difference_type n) const
Definition RingImageCollection.cc:455
RingImageMutableCollectionIterator(size_t index, const RingImageObjPointerContainer *collection)
Definition RingImageCollection.h:96
RingImageMutableCollectionIterator & operator-=(difference_type n)
Definition RingImageCollection.cc:450
RingImageMutableCollectionIterator & operator=(const RingImageMutableCollectionIterator &)=default
Definition RingImageObj.h:17
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< RingImageObj * > RingImageObjPointerContainer
Definition RingImageCollectionData.h:22
Definition CalorimeterHit.h:31