EDM4eic
EIC data model
Loading...
Searching...
No Matches
TrackerHitCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_TrackerHitCollection_H
4#define EDM4EIC_TrackerHitCollection_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 TrackerHitCollectionIterator(size_t index, const TrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackerHitObj>{nullptr}), m_collection(collection) {}
49
55
56 auto operator<=>(const TrackerHitCollectionIterator& 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 TrackerHit m_object { podio::utils::MaybeSharedPtr<TrackerHitObj>{nullptr} };
81 const TrackerHitObjPointerContainer* 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 TrackerHitMutableCollectionIterator(size_t index, const TrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackerHitObj>{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 MutableTrackerHit m_object { podio::utils::MaybeSharedPtr<TrackerHitObj>{nullptr} };
130 const TrackerHitObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class TrackerHitCollection : 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 TrackerHitCollection(TrackerHitCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// TrackerHitCollection(TrackerHitVector* data, uint32_t collectionID);
157 ~TrackerHitCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::TrackerHitCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::TrackerHit";
161 constexpr static std::string_view dataTypeName = "edm4eic::TrackerHitData";
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 TrackerHitCollection* operator->() { return static_cast<TrackerHitCollection*>(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 MutableTrackerHit 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 TrackerHit operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableTrackerHit operator[](std::size_t index);
207 /// Returns the const object of given index
208 TrackerHit at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableTrackerHit at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableTrackerHit& object);
215 /// Append an object to the (subset) collection
216 void push_back(const TrackerHit& 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] (TrackerHitObj* 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> cellID(const size_t nElem = 0) const;
286 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
287 std::vector<edm4eic::CovDiag3f> positionError(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<float> edep(const size_t nElem = 0) const;
291 std::vector<float> edepError(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 TrackerHitCollectionData m_storage{};
305};
306
307std::ostream& operator<<(std::ostream& o, const TrackerHitCollection& 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 TrackerHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
316 m_storage.entries.push_back(obj);
317
318 return MutableTrackerHit(podio::utils::MaybeSharedPtr(obj));
319}
320
321#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
322void to_json(nlohmann::json& j, const TrackerHitCollection& collection);
323#endif
324
325} // namespace edm4eic
326
327
328#endif
Definition MutableTrackerHit.h:37
Definition TrackerHitCollectionData.h:31
Definition TrackerHitCollection.h:137
friend class TrackerHitCollectionData
Definition TrackerHitCollection.h:297
std::reverse_iterator< iterator > reverse_iterator
Definition TrackerHitCollection.h:146
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition TrackerHitCollection.h:191
TrackerHitCollection()
Definition TrackerHitCollection.cc:24
TrackerHit value_type
Definition TrackerHitCollection.h:139
const_iterator cbegin() const
Definition TrackerHitCollection.h:252
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition TrackerHitCollection.cc:498
bool empty() const final
Is the collection empty.
Definition TrackerHitCollection.cc:65
const_reverse_iterator crend() const
Definition TrackerHitCollection.h:280
const_iterator end() const
Definition TrackerHitCollection.h:258
static constexpr std::string_view valueTypeName
Definition TrackerHitCollection.h:160
TrackerHit at(std::size_t index) const
Returns the const object of given index.
Definition TrackerHitCollection.cc:39
const_iterator begin() const
Definition TrackerHitCollection.h:249
void prepareAfterRead() final
Definition TrackerHitCollection.cc:105
reverse_iterator rbegin()
Definition TrackerHitCollection.h:265
~TrackerHitCollection() override
Definition TrackerHitCollection.cc:30
const_iterator cend() const
Definition TrackerHitCollection.h:261
TrackerHitCollection & operator=(const TrackerHitCollection &)=delete
bool isSubsetCollection() const final
Definition TrackerHitCollection.h:197
std::size_t size() const final
number of elements in the collection
Definition TrackerHitCollection.cc:51
size_t size_type
Definition TrackerHitCollection.h:144
const std::string_view getTypeName() const final
fully qualified type name
Definition TrackerHitCollection.h:189
MutableTrackerHit create()
Append a new object to the collection, and return this object.
Definition TrackerHitCollection.cc:80
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition TrackerHitCollection.cc:156
MutableTrackerHit mutable_type
Definition TrackerHitCollection.h:140
const_reverse_iterator crbegin() const
Definition TrackerHitCollection.h:271
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition TrackerHitCollection.cc:235
iterator begin()
Definition TrackerHitCollection.h:246
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition TrackerHitCollection.h:145
const_reverse_iterator rend() const
Definition TrackerHitCollection.h:277
static constexpr std::string_view typeName
Definition TrackerHitCollection.h:159
uint32_t getID() const final
Definition TrackerHitCollection.h:235
TrackerHitCollection(const TrackerHitCollection &)=delete
void setSubsetCollection(bool setSubset=true) final
Definition TrackerHitCollection.cc:69
ptrdiff_t difference_type
Definition TrackerHitCollection.h:143
TrackerHitCollection & operator=(TrackerHitCollection &&)=default
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition TrackerHitCollection.cc:120
const_reverse_iterator rbegin() const
Definition TrackerHitCollection.h:268
std::size_t max_size() const final
maximal number of elements in the collection
Definition TrackerHitCollection.cc:55
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition TrackerHitCollection.h:193
bool isValid() const final
Definition TrackerHitCollection.h:239
static constexpr std::string_view dataTypeName
Definition TrackerHitCollection.h:161
iterator end()
Definition TrackerHitCollection.h:255
TrackerHitCollection(TrackerHitCollection &&)=default
TrackerHitCollectionIterator const_iterator
Definition TrackerHitCollection.h:141
void clear() final
Definition TrackerHitCollection.cc:91
void prepareForWrite() const final
Definition TrackerHitCollection.cc:96
reverse_iterator rend()
Definition TrackerHitCollection.h:274
TrackerHitMutableCollectionIterator iterator
Definition TrackerHitCollection.h:142
void setID(uint32_t ID) final
Definition TrackerHitCollection.h:225
void push_back(const MutableTrackerHit &object)
Append object to the collection.
Definition TrackerHitCollection.cc:124
Definition TrackerHitCollection.h:36
std::input_iterator_tag iterator_category
Definition TrackerHitCollection.h:42
bool operator==(const TrackerHitCollectionIterator &x) const
Definition TrackerHitCollection.h:60
TrackerHitCollectionIterator & operator++()
Definition TrackerHitCollection.cc:347
TrackerHitCollectionIterator(size_t index, const TrackerHitObjPointerContainer *collection)
Definition TrackerHitCollection.h:47
TrackerHitCollectionIterator operator-(difference_type n) const
Definition TrackerHitCollection.cc:389
TrackerHit * pointer
Definition TrackerHitCollection.h:41
TrackerHitCollectionIterator & operator+=(difference_type n)
Definition TrackerHitCollection.cc:369
pointer operator->()
Definition TrackerHitCollection.cc:342
TrackerHit value_type
Definition TrackerHitCollection.h:38
TrackerHitCollectionIterator & operator=(TrackerHitCollectionIterator &&)=default
TrackerHitCollectionIterator & operator--()
Definition TrackerHitCollection.cc:358
std::random_access_iterator_tag iterator_concept
Definition TrackerHitCollection.h:45
TrackerHitCollectionIterator & operator-=(difference_type n)
Definition TrackerHitCollection.cc:384
TrackerHitCollectionIterator & operator=(const TrackerHitCollectionIterator &)=default
auto operator<=>(const TrackerHitCollectionIterator &other) const
Definition TrackerHitCollection.h:56
ptrdiff_t difference_type
Definition TrackerHitCollection.h:39
reference operator*() const
Definition TrackerHitCollection.cc:338
TrackerHitCollectionIterator(TrackerHitCollectionIterator &&)=default
TrackerHitCollectionIterator operator+(difference_type n) const
Definition TrackerHitCollection.cc:374
TrackerHit reference
Definition TrackerHitCollection.h:40
TrackerHitCollectionIterator(const TrackerHitCollectionIterator &)=default
reference operator[](difference_type n) const
Definition TrackerHitCollection.cc:395
Definition TrackerHit.h:45
Definition TrackerHitCollection.h:85
auto operator<=>(const TrackerHitMutableCollectionIterator &other) const
Definition TrackerHitCollection.h:105
MutableTrackerHit reference
Definition TrackerHitCollection.h:89
TrackerHitMutableCollectionIterator & operator-=(difference_type n)
Definition TrackerHitCollection.cc:451
pointer operator->()
Definition TrackerHitCollection.cc:409
bool operator==(const TrackerHitMutableCollectionIterator &x) const
Definition TrackerHitCollection.h:109
TrackerHitMutableCollectionIterator & operator=(TrackerHitMutableCollectionIterator &&)=default
MutableTrackerHit * pointer
Definition TrackerHitCollection.h:90
TrackerHitMutableCollectionIterator & operator++()
Definition TrackerHitCollection.cc:414
std::input_iterator_tag iterator_category
Definition TrackerHitCollection.h:91
TrackerHit value_type
Definition TrackerHitCollection.h:87
TrackerHitMutableCollectionIterator & operator=(const TrackerHitMutableCollectionIterator &)=default
TrackerHitMutableCollectionIterator(size_t index, const TrackerHitObjPointerContainer *collection)
Definition TrackerHitCollection.h:96
std::random_access_iterator_tag iterator_concept
Definition TrackerHitCollection.h:94
TrackerHitMutableCollectionIterator & operator--()
Definition TrackerHitCollection.cc:425
reference operator*() const
Definition TrackerHitCollection.cc:405
TrackerHitMutableCollectionIterator operator+(difference_type n) const
Definition TrackerHitCollection.cc:441
TrackerHitMutableCollectionIterator(TrackerHitMutableCollectionIterator &&)=default
reference operator[](difference_type n) const
Definition TrackerHitCollection.cc:462
ptrdiff_t difference_type
Definition TrackerHitCollection.h:88
TrackerHitMutableCollectionIterator operator-(difference_type n) const
Definition TrackerHitCollection.cc:456
TrackerHitMutableCollectionIterator & operator+=(difference_type n)
Definition TrackerHitCollection.cc:436
TrackerHitMutableCollectionIterator(const TrackerHitMutableCollectionIterator &)=default
Definition TrackerHitObj.h:21
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< TrackerHitObj * > TrackerHitObjPointerContainer
Definition TrackerHitCollectionData.h:23
Definition CalorimeterHit.h:31