EDM4eic
EIC data model
Loading...
Searching...
No Matches
Measurement2DCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_Measurement2DCollection_H
4#define EDM4EIC_Measurement2DCollection_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 Measurement2DCollectionIterator(size_t index, const Measurement2DObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<Measurement2DObj>{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 Measurement2D m_object { podio::utils::MaybeSharedPtr<Measurement2DObj>{nullptr} };
81 const Measurement2DObjPointerContainer* 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 Measurement2DMutableCollectionIterator(size_t index, const Measurement2DObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<Measurement2DObj>{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 MutableMeasurement2D m_object { podio::utils::MaybeSharedPtr<Measurement2DObj>{nullptr} };
130 const Measurement2DObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class Measurement2DCollection : 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 Measurement2DCollection(Measurement2DCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// Measurement2DCollection(Measurement2DVector* data, uint32_t collectionID);
157 ~Measurement2DCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::Measurement2DCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::Measurement2D";
161 constexpr static std::string_view dataTypeName = "edm4eic::Measurement2DData";
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 Measurement2DCollection* operator->() { return static_cast<Measurement2DCollection*>(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 MutableMeasurement2D 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 Measurement2D operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableMeasurement2D operator[](std::size_t index);
207 /// Returns the const object of given index
208 Measurement2D at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableMeasurement2D at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableMeasurement2D& object);
215 /// Append an object to the (subset) collection
216 void push_back(const Measurement2D& 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] (Measurement2DObj* 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::uint64_t> surface(const size_t nElem = 0) const;
286 std::vector<edm4hep::Vector2f> loc(const size_t nElem = 0) const;
287 std::vector<float> time(const size_t nElem = 0) const;
288 std::vector<edm4eic::Cov3f> covariance(const size_t nElem = 0) const;
289
290private:
291 // For setReferences, we need to give our own CollectionData access to our
292 // private entries. Otherwise we would need to expose a public member function
293 // that gives access to the Obj* which is definitely not what we want
295
296 bool m_isValid{false};
297 mutable bool m_isPrepared{false};
298 bool m_isSubsetColl{false};
299 uint32_t m_collectionID{0};
300 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
301 mutable Measurement2DCollectionData m_storage{};
302};
303
304std::ostream& operator<<(std::ostream& o, const Measurement2DCollection& v);
305
306template<typename... Args>
308 if (m_isSubsetColl) {
309 throw std::logic_error("Cannot create new elements on a subset collection");
310 }
311 const int size = m_storage.entries.size();
312 auto obj = new Measurement2DObj({size, m_collectionID}, {std::forward<Args>(args)...});
313 m_storage.entries.push_back(obj);
314
315 // Need to initialize the relation vectors manually for the {ObjectID, Measurement2DData} constructor
316 obj->m_hits = new std::vector<edm4eic::TrackerHit>();
317 obj->m_weights = new std::vector<float>();
318 m_storage.createRelations(obj);
319 return MutableMeasurement2D(podio::utils::MaybeSharedPtr(obj));
320}
321
322#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
323void to_json(nlohmann::json& j, const Measurement2DCollection& collection);
324#endif
325
326} // namespace edm4eic
327
328
329#endif
Definition Measurement2DCollectionData.h:31
Definition Measurement2DCollection.h:137
void setSubsetCollection(bool setSubset=true) final
Definition Measurement2DCollection.cc:70
bool isValid() const final
Definition Measurement2DCollection.h:239
void clear() final
Definition Measurement2DCollection.cc:93
const std::string_view getTypeName() const final
fully qualified type name
Definition Measurement2DCollection.h:189
const_iterator end() const
Definition Measurement2DCollection.h:258
const_iterator begin() const
Definition Measurement2DCollection.h:249
static constexpr std::string_view dataTypeName
Definition Measurement2DCollection.h:161
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition Measurement2DCollection.cc:122
size_t size_type
Definition Measurement2DCollection.h:144
void prepareForWrite() const final
Definition Measurement2DCollection.cc:98
std::size_t size() const final
number of elements in the collection
Definition Measurement2DCollection.cc:52
friend class Measurement2DCollectionData
Definition Measurement2DCollection.h:294
const_reverse_iterator crend() const
Definition Measurement2DCollection.h:280
MutableMeasurement2D create()
Append a new object to the collection, and return this object.
Definition Measurement2DCollection.cc:81
Measurement2D at(std::size_t index) const
Returns the const object of given index.
Definition Measurement2DCollection.cc:40
iterator end()
Definition Measurement2DCollection.h:255
reverse_iterator rbegin()
Definition Measurement2DCollection.h:265
bool empty() const final
Is the collection empty.
Definition Measurement2DCollection.cc:66
Measurement2DCollection & operator=(const Measurement2DCollection &)=delete
iterator begin()
Definition Measurement2DCollection.h:246
const_reverse_iterator rbegin() const
Definition Measurement2DCollection.h:268
const_iterator cbegin() const
Definition Measurement2DCollection.h:252
Measurement2DCollection()
Definition Measurement2DCollection.cc:25
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition Measurement2DCollection.cc:159
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition Measurement2DCollection.cc:208
const_reverse_iterator crbegin() const
Definition Measurement2DCollection.h:271
void push_back(const MutableMeasurement2D &object)
Append object to the collection.
Definition Measurement2DCollection.cc:126
MutableMeasurement2D mutable_type
Definition Measurement2DCollection.h:140
void setID(uint32_t ID) final
Definition Measurement2DCollection.h:225
Measurement2D value_type
Definition Measurement2DCollection.h:139
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition Measurement2DCollection.h:193
Measurement2DCollection(Measurement2DCollection &&)=default
std::reverse_iterator< iterator > reverse_iterator
Definition Measurement2DCollection.h:146
std::size_t max_size() const final
maximal number of elements in the collection
Definition Measurement2DCollection.cc:56
const_reverse_iterator rend() const
Definition Measurement2DCollection.h:277
reverse_iterator rend()
Definition Measurement2DCollection.h:274
Measurement2DMutableCollectionIterator iterator
Definition Measurement2DCollection.h:142
uint32_t getID() const final
Definition Measurement2DCollection.h:235
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition Measurement2DCollection.cc:479
static constexpr std::string_view typeName
Definition Measurement2DCollection.h:159
Measurement2DCollection(const Measurement2DCollection &)=delete
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition Measurement2DCollection.h:145
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition Measurement2DCollection.h:191
Measurement2DCollection & operator=(Measurement2DCollection &&)=default
Measurement2DCollectionIterator const_iterator
Definition Measurement2DCollection.h:141
~Measurement2DCollection() override
Definition Measurement2DCollection.cc:31
const_iterator cend() const
Definition Measurement2DCollection.h:261
void prepareAfterRead() final
Definition Measurement2DCollection.cc:107
bool isSubsetCollection() const final
Definition Measurement2DCollection.h:197
static constexpr std::string_view valueTypeName
Definition Measurement2DCollection.h:160
ptrdiff_t difference_type
Definition Measurement2DCollection.h:143
Definition Measurement2DCollection.h:36
Measurement2D * pointer
Definition Measurement2DCollection.h:41
Measurement2DCollectionIterator & operator+=(difference_type n)
Definition Measurement2DCollection.cc:345
Measurement2DCollectionIterator(Measurement2DCollectionIterator &&)=default
reference operator[](difference_type n) const
Definition Measurement2DCollection.cc:371
Measurement2DCollectionIterator operator-(difference_type n) const
Definition Measurement2DCollection.cc:365
std::input_iterator_tag iterator_category
Definition Measurement2DCollection.h:42
Measurement2DCollectionIterator & operator=(const Measurement2DCollectionIterator &)=default
Measurement2DCollectionIterator & operator--()
Definition Measurement2DCollection.cc:334
Measurement2D reference
Definition Measurement2DCollection.h:40
std::random_access_iterator_tag iterator_concept
Definition Measurement2DCollection.h:45
Measurement2DCollectionIterator & operator-=(difference_type n)
Definition Measurement2DCollection.cc:360
Measurement2D value_type
Definition Measurement2DCollection.h:38
auto operator<=>(const Measurement2DCollectionIterator &other) const
Definition Measurement2DCollection.h:56
Measurement2DCollectionIterator(const Measurement2DCollectionIterator &)=default
pointer operator->()
Definition Measurement2DCollection.cc:318
ptrdiff_t difference_type
Definition Measurement2DCollection.h:39
Measurement2DCollectionIterator & operator=(Measurement2DCollectionIterator &&)=default
Measurement2DCollectionIterator(size_t index, const Measurement2DObjPointerContainer *collection)
Definition Measurement2DCollection.h:47
Measurement2DCollectionIterator & operator++()
Definition Measurement2DCollection.cc:323
bool operator==(const Measurement2DCollectionIterator &x) const
Definition Measurement2DCollection.h:60
Measurement2DCollectionIterator operator+(difference_type n) const
Definition Measurement2DCollection.cc:350
reference operator*() const
Definition Measurement2DCollection.cc:314
Definition Measurement2D.h:46
Definition Measurement2DCollection.h:85
Measurement2DMutableCollectionIterator & operator=(Measurement2DMutableCollectionIterator &&)=default
Measurement2DMutableCollectionIterator & operator=(const Measurement2DMutableCollectionIterator &)=default
MutableMeasurement2D reference
Definition Measurement2DCollection.h:89
MutableMeasurement2D * pointer
Definition Measurement2DCollection.h:90
reference operator*() const
Definition Measurement2DCollection.cc:381
Measurement2DMutableCollectionIterator operator-(difference_type n) const
Definition Measurement2DCollection.cc:432
Measurement2DMutableCollectionIterator & operator--()
Definition Measurement2DCollection.cc:401
Measurement2DMutableCollectionIterator & operator++()
Definition Measurement2DCollection.cc:390
Measurement2DMutableCollectionIterator(const Measurement2DMutableCollectionIterator &)=default
Measurement2DMutableCollectionIterator(Measurement2DMutableCollectionIterator &&)=default
Measurement2D value_type
Definition Measurement2DCollection.h:87
auto operator<=>(const Measurement2DMutableCollectionIterator &other) const
Definition Measurement2DCollection.h:105
Measurement2DMutableCollectionIterator & operator+=(difference_type n)
Definition Measurement2DCollection.cc:412
Measurement2DMutableCollectionIterator(size_t index, const Measurement2DObjPointerContainer *collection)
Definition Measurement2DCollection.h:96
pointer operator->()
Definition Measurement2DCollection.cc:385
ptrdiff_t difference_type
Definition Measurement2DCollection.h:88
bool operator==(const Measurement2DMutableCollectionIterator &x) const
Definition Measurement2DCollection.h:109
std::input_iterator_tag iterator_category
Definition Measurement2DCollection.h:91
Measurement2DMutableCollectionIterator operator+(difference_type n) const
Definition Measurement2DCollection.cc:417
Measurement2DMutableCollectionIterator & operator-=(difference_type n)
Definition Measurement2DCollection.cc:427
std::random_access_iterator_tag iterator_concept
Definition Measurement2DCollection.h:94
reference operator[](difference_type n) const
Definition Measurement2DCollection.cc:438
Definition Measurement2DObj.h:20
std::vector< edm4eic::TrackerHit > * m_hits
Definition Measurement2DObj.h:36
Definition MutableMeasurement2D.h:38
Definition CalorimeterHit.cc:17
std::deque< Measurement2DObj * > Measurement2DObjPointerContainer
Definition Measurement2DCollectionData.h:23
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:31