EDM4eic
EIC data model
Loading...
Searching...
No Matches
RawTrackerHitCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_RawTrackerHitCollection_H
4#define EDM4EIC_RawTrackerHitCollection_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 RawTrackerHitCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RawTrackerHitObj>{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 RawTrackerHit m_object { podio::utils::MaybeSharedPtr<RawTrackerHitObj>{nullptr} };
81 const RawTrackerHitObjPointerContainer* 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 RawTrackerHitMutableCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RawTrackerHitObj>{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 MutableRawTrackerHit m_object { podio::utils::MaybeSharedPtr<RawTrackerHitObj>{nullptr} };
130 const RawTrackerHitObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class RawTrackerHitCollection : 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 RawTrackerHitCollection(RawTrackerHitCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// RawTrackerHitCollection(RawTrackerHitVector* data, uint32_t collectionID);
157 ~RawTrackerHitCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::RawTrackerHitCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::RawTrackerHit";
161 constexpr static std::string_view dataTypeName = "edm4eic::RawTrackerHitData";
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 RawTrackerHitCollection* operator->() { return static_cast<RawTrackerHitCollection*>(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 MutableRawTrackerHit 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 RawTrackerHit operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableRawTrackerHit operator[](std::size_t index);
207 /// Returns the const object of given index
208 RawTrackerHit at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableRawTrackerHit at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableRawTrackerHit& object);
215 /// Append an object to the (subset) collection
216 void push_back(const RawTrackerHit& 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] (RawTrackerHitObj* 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<std::int32_t> charge(const size_t nElem = 0) const;
287 std::vector<std::int32_t> timeStamp(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 RawTrackerHitCollectionData m_storage{};
301};
302
303std::ostream& operator<<(std::ostream& o, const RawTrackerHitCollection& 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 RawTrackerHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
312 m_storage.entries.push_back(obj);
313
314 return MutableRawTrackerHit(podio::utils::MaybeSharedPtr(obj));
315}
316
317#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
318void to_json(nlohmann::json& j, const RawTrackerHitCollection& collection);
319#endif
320
321} // namespace edm4eic
322
323
324#endif
Definition MutableRawTrackerHit.h:33
Definition RawTrackerHitCollectionData.h:30
Definition RawTrackerHitCollection.h:137
std::size_t max_size() const final
maximal number of elements in the collection
Definition RawTrackerHitCollection.cc:54
RawTrackerHit value_type
Definition RawTrackerHitCollection.h:139
RawTrackerHitCollection & operator=(RawTrackerHitCollection &&)=default
static constexpr std::string_view valueTypeName
Definition RawTrackerHitCollection.h:160
iterator end()
Definition RawTrackerHitCollection.h:255
const_reverse_iterator rbegin() const
Definition RawTrackerHitCollection.h:268
void push_back(const MutableRawTrackerHit &object)
Append object to the collection.
Definition RawTrackerHitCollection.cc:123
void prepareForWrite() const final
Definition RawTrackerHitCollection.cc:95
RawTrackerHitMutableCollectionIterator iterator
Definition RawTrackerHitCollection.h:142
RawTrackerHitCollection(const RawTrackerHitCollection &)=delete
RawTrackerHitCollection()
Definition RawTrackerHitCollection.cc:23
void setSubsetCollection(bool setSubset=true) final
Definition RawTrackerHitCollection.cc:68
uint32_t getID() const final
Definition RawTrackerHitCollection.h:235
const_iterator cbegin() const
Definition RawTrackerHitCollection.h:252
const_iterator begin() const
Definition RawTrackerHitCollection.h:249
void setID(uint32_t ID) final
Definition RawTrackerHitCollection.h:225
const_iterator cend() const
Definition RawTrackerHitCollection.h:261
bool isSubsetCollection() const final
Definition RawTrackerHitCollection.h:197
const_reverse_iterator rend() const
Definition RawTrackerHitCollection.h:277
MutableRawTrackerHit mutable_type
Definition RawTrackerHitCollection.h:140
RawTrackerHitCollectionIterator const_iterator
Definition RawTrackerHitCollection.h:141
bool empty() const final
Is the collection empty.
Definition RawTrackerHitCollection.cc:64
const std::string_view getTypeName() const final
fully qualified type name
Definition RawTrackerHitCollection.h:189
RawTrackerHitCollection(RawTrackerHitCollection &&)=default
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition RawTrackerHitCollection.cc:451
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition RawTrackerHitCollection.h:191
RawTrackerHit at(std::size_t index) const
Returns the const object of given index.
Definition RawTrackerHitCollection.cc:38
const_reverse_iterator crbegin() const
Definition RawTrackerHitCollection.h:271
ptrdiff_t difference_type
Definition RawTrackerHitCollection.h:143
const_iterator end() const
Definition RawTrackerHitCollection.h:258
reverse_iterator rbegin()
Definition RawTrackerHitCollection.h:265
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition RawTrackerHitCollection.h:145
static constexpr std::string_view typeName
Definition RawTrackerHitCollection.h:159
MutableRawTrackerHit create()
Append a new object to the collection, and return this object.
Definition RawTrackerHitCollection.cc:79
const_reverse_iterator crend() const
Definition RawTrackerHitCollection.h:280
static constexpr std::string_view dataTypeName
Definition RawTrackerHitCollection.h:161
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition RawTrackerHitCollection.cc:119
std::reverse_iterator< iterator > reverse_iterator
Definition RawTrackerHitCollection.h:146
RawTrackerHitCollection & operator=(const RawTrackerHitCollection &)=delete
bool isValid() const final
Definition RawTrackerHitCollection.h:239
~RawTrackerHitCollection() override
Definition RawTrackerHitCollection.cc:29
void clear() final
Definition RawTrackerHitCollection.cc:90
size_t size_type
Definition RawTrackerHitCollection.h:144
reverse_iterator rend()
Definition RawTrackerHitCollection.h:274
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition RawTrackerHitCollection.cc:194
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition RawTrackerHitCollection.cc:155
iterator begin()
Definition RawTrackerHitCollection.h:246
void prepareAfterRead() final
Definition RawTrackerHitCollection.cc:104
friend class RawTrackerHitCollectionData
Definition RawTrackerHitCollection.h:293
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition RawTrackerHitCollection.h:193
std::size_t size() const final
number of elements in the collection
Definition RawTrackerHitCollection.cc:50
Definition RawTrackerHitCollection.h:36
std::input_iterator_tag iterator_category
Definition RawTrackerHitCollection.h:42
auto operator<=>(const RawTrackerHitCollectionIterator &other) const
Definition RawTrackerHitCollection.h:56
RawTrackerHitCollectionIterator & operator=(const RawTrackerHitCollectionIterator &)=default
RawTrackerHit reference
Definition RawTrackerHitCollection.h:40
RawTrackerHitCollectionIterator & operator=(RawTrackerHitCollectionIterator &&)=default
RawTrackerHitCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer *collection)
Definition RawTrackerHitCollection.h:47
reference operator*() const
Definition RawTrackerHitCollection.cc:297
RawTrackerHitCollectionIterator & operator--()
Definition RawTrackerHitCollection.cc:317
ptrdiff_t difference_type
Definition RawTrackerHitCollection.h:39
bool operator==(const RawTrackerHitCollectionIterator &x) const
Definition RawTrackerHitCollection.h:60
reference operator[](difference_type n) const
Definition RawTrackerHitCollection.cc:354
RawTrackerHit value_type
Definition RawTrackerHitCollection.h:38
RawTrackerHitCollectionIterator & operator-=(difference_type n)
Definition RawTrackerHitCollection.cc:343
RawTrackerHitCollectionIterator(RawTrackerHitCollectionIterator &&)=default
RawTrackerHitCollectionIterator operator-(difference_type n) const
Definition RawTrackerHitCollection.cc:348
std::random_access_iterator_tag iterator_concept
Definition RawTrackerHitCollection.h:45
pointer operator->()
Definition RawTrackerHitCollection.cc:301
RawTrackerHit * pointer
Definition RawTrackerHitCollection.h:41
RawTrackerHitCollectionIterator(const RawTrackerHitCollectionIterator &)=default
RawTrackerHitCollectionIterator & operator+=(difference_type n)
Definition RawTrackerHitCollection.cc:328
RawTrackerHitCollectionIterator & operator++()
Definition RawTrackerHitCollection.cc:306
RawTrackerHitCollectionIterator operator+(difference_type n) const
Definition RawTrackerHitCollection.cc:333
Definition RawTrackerHit.h:41
Definition RawTrackerHitCollection.h:85
RawTrackerHitMutableCollectionIterator & operator++()
Definition RawTrackerHitCollection.cc:373
ptrdiff_t difference_type
Definition RawTrackerHitCollection.h:88
auto operator<=>(const RawTrackerHitMutableCollectionIterator &other) const
Definition RawTrackerHitCollection.h:105
RawTrackerHit value_type
Definition RawTrackerHitCollection.h:87
RawTrackerHitMutableCollectionIterator(RawTrackerHitMutableCollectionIterator &&)=default
MutableRawTrackerHit reference
Definition RawTrackerHitCollection.h:89
RawTrackerHitMutableCollectionIterator & operator=(const RawTrackerHitMutableCollectionIterator &)=default
reference operator[](difference_type n) const
Definition RawTrackerHitCollection.cc:421
std::input_iterator_tag iterator_category
Definition RawTrackerHitCollection.h:91
std::random_access_iterator_tag iterator_concept
Definition RawTrackerHitCollection.h:94
RawTrackerHitMutableCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer *collection)
Definition RawTrackerHitCollection.h:96
pointer operator->()
Definition RawTrackerHitCollection.cc:368
RawTrackerHitMutableCollectionIterator & operator--()
Definition RawTrackerHitCollection.cc:384
RawTrackerHitMutableCollectionIterator & operator+=(difference_type n)
Definition RawTrackerHitCollection.cc:395
bool operator==(const RawTrackerHitMutableCollectionIterator &x) const
Definition RawTrackerHitCollection.h:109
reference operator*() const
Definition RawTrackerHitCollection.cc:364
RawTrackerHitMutableCollectionIterator(const RawTrackerHitMutableCollectionIterator &)=default
RawTrackerHitMutableCollectionIterator operator-(difference_type n) const
Definition RawTrackerHitCollection.cc:415
RawTrackerHitMutableCollectionIterator & operator-=(difference_type n)
Definition RawTrackerHitCollection.cc:410
MutableRawTrackerHit * pointer
Definition RawTrackerHitCollection.h:90
RawTrackerHitMutableCollectionIterator & operator=(RawTrackerHitMutableCollectionIterator &&)=default
RawTrackerHitMutableCollectionIterator operator+(difference_type n) const
Definition RawTrackerHitCollection.cc:400
Definition RawTrackerHitObj.h:17
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< RawTrackerHitObj * > RawTrackerHitObjPointerContainer
Definition RawTrackerHitCollectionData.h:22
Definition CalorimeterHit.h:31