EDM4eic
EIC data model
Loading...
Searching...
No Matches
CalorimeterHitCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_CalorimeterHitCollection_H
4#define EDM4EIC_CalorimeterHitCollection_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 CalorimeterHitCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<CalorimeterHitObj>{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 CalorimeterHit m_object { podio::utils::MaybeSharedPtr<CalorimeterHitObj>{nullptr} };
81 const CalorimeterHitObjPointerContainer* 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 CalorimeterHitMutableCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<CalorimeterHitObj>{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 MutableCalorimeterHit m_object { podio::utils::MaybeSharedPtr<CalorimeterHitObj>{nullptr} };
130 const CalorimeterHitObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class CalorimeterHitCollection : 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
150 // This is a move-only type
155
156// CalorimeterHitCollection(CalorimeterHitVector* data, uint32_t collectionID);
157 ~CalorimeterHitCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::CalorimeterHitCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::CalorimeterHit";
161 constexpr static std::string_view dataTypeName = "edm4eic::CalorimeterHitData";
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 CalorimeterHitCollection* operator->() { return static_cast<CalorimeterHitCollection*>(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 MutableCalorimeterHit 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 CalorimeterHit operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableCalorimeterHit operator[](std::size_t index);
207 /// Returns the const object of given index
208 CalorimeterHit at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableCalorimeterHit at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableCalorimeterHit& object);
215 /// Append an object to the (subset) collection
216 void push_back(const CalorimeterHit& 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] (CalorimeterHitObj* 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<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<edm4hep::Vector3f> position(const size_t nElem = 0) const;
291 std::vector<edm4hep::Vector3f> dimension(const size_t nElem = 0) const;
292 std::vector<std::int32_t> sector(const size_t nElem = 0) const;
293 std::vector<std::int32_t> layer(const size_t nElem = 0) const;
294 std::vector<edm4hep::Vector3f> local(const size_t nElem = 0) const;
295
296private:
297 // For setReferences, we need to give our own CollectionData access to our
298 // private entries. Otherwise we would need to expose a public member function
299 // that gives access to the Obj* which is definitely not what we want
301
302 bool m_isValid{false};
303 mutable bool m_isPrepared{false};
304 bool m_isSubsetColl{false};
305 uint32_t m_collectionID{0};
306 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
307 mutable CalorimeterHitCollectionData m_storage{};
308};
309
310std::ostream& operator<<(std::ostream& o, const CalorimeterHitCollection& v);
311
312template<typename... Args>
314 if (m_isSubsetColl) {
315 throw std::logic_error("Cannot create new elements on a subset collection");
316 }
317 const int size = m_storage.entries.size();
318 auto obj = new CalorimeterHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
319 m_storage.entries.push_back(obj);
320
321 return MutableCalorimeterHit(podio::utils::MaybeSharedPtr(obj));
322}
323
324#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
325void to_json(nlohmann::json& j, const CalorimeterHitCollection& collection);
326#endif
327
328} // namespace edm4eic
329
330
331#endif
Definition CalorimeterHitCollectionData.h:31
Definition CalorimeterHitCollection.h:137
static constexpr std::string_view dataTypeName
Definition CalorimeterHitCollection.h:161
size_t size_type
Definition CalorimeterHitCollection.h:144
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition CalorimeterHitCollection.cc:120
reverse_iterator rbegin()
Definition CalorimeterHitCollection.h:265
MutableCalorimeterHit create()
Append a new object to the collection, and return this object.
Definition CalorimeterHitCollection.cc:80
void setID(uint32_t ID) final
Definition CalorimeterHitCollection.h:225
std::size_t max_size() const final
maximal number of elements in the collection
Definition CalorimeterHitCollection.cc:55
const_iterator end() const
Definition CalorimeterHitCollection.h:258
const_reverse_iterator crbegin() const
Definition CalorimeterHitCollection.h:271
MutableCalorimeterHit mutable_type
Definition CalorimeterHitCollection.h:140
bool empty() const final
Is the collection empty.
Definition CalorimeterHitCollection.cc:65
CalorimeterHitCollection(CalorimeterHitCollection &&)=default
~CalorimeterHitCollection() override
Definition CalorimeterHitCollection.cc:30
void setSubsetCollection(bool setSubset=true) final
Definition CalorimeterHitCollection.cc:69
static constexpr std::string_view valueTypeName
Definition CalorimeterHitCollection.h:160
const_iterator cend() const
Definition CalorimeterHitCollection.h:261
static constexpr std::string_view typeName
Definition CalorimeterHitCollection.h:159
ptrdiff_t difference_type
Definition CalorimeterHitCollection.h:143
friend class CalorimeterHitCollectionData
Definition CalorimeterHitCollection.h:300
uint32_t getID() const final
Definition CalorimeterHitCollection.h:235
bool isSubsetCollection() const final
Definition CalorimeterHitCollection.h:197
CalorimeterHit value_type
Definition CalorimeterHitCollection.h:139
CalorimeterHitCollectionIterator const_iterator
Definition CalorimeterHitCollection.h:141
const_reverse_iterator crend() const
Definition CalorimeterHitCollection.h:280
std::size_t size() const final
number of elements in the collection
Definition CalorimeterHitCollection.cc:51
const_reverse_iterator rend() const
Definition CalorimeterHitCollection.h:277
std::reverse_iterator< iterator > reverse_iterator
Definition CalorimeterHitCollection.h:146
bool isValid() const final
Definition CalorimeterHitCollection.h:239
const_reverse_iterator rbegin() const
Definition CalorimeterHitCollection.h:268
CalorimeterHitCollection(const CalorimeterHitCollection &)=delete
reverse_iterator rend()
Definition CalorimeterHitCollection.h:274
iterator end()
Definition CalorimeterHitCollection.h:255
const_iterator begin() const
Definition CalorimeterHitCollection.h:249
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition CalorimeterHitCollection.h:191
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition CalorimeterHitCollection.cc:531
CalorimeterHitMutableCollectionIterator iterator
Definition CalorimeterHitCollection.h:142
CalorimeterHitCollection & operator=(const CalorimeterHitCollection &)=delete
void prepareForWrite() const final
Definition CalorimeterHitCollection.cc:96
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition CalorimeterHitCollection.cc:265
iterator begin()
Definition CalorimeterHitCollection.h:246
CalorimeterHit at(std::size_t index) const
Returns the const object of given index.
Definition CalorimeterHitCollection.cc:39
CalorimeterHitCollection()
Definition CalorimeterHitCollection.cc:24
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition CalorimeterHitCollection.cc:156
void clear() final
Definition CalorimeterHitCollection.cc:91
void push_back(const MutableCalorimeterHit &object)
Append object to the collection.
Definition CalorimeterHitCollection.cc:124
void prepareAfterRead() final
Definition CalorimeterHitCollection.cc:105
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition CalorimeterHitCollection.h:193
const std::string_view getTypeName() const final
fully qualified type name
Definition CalorimeterHitCollection.h:189
const_iterator cbegin() const
Definition CalorimeterHitCollection.h:252
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition CalorimeterHitCollection.h:145
CalorimeterHitCollection & operator=(CalorimeterHitCollection &&)=default
Definition CalorimeterHitCollection.h:36
CalorimeterHitCollectionIterator(const CalorimeterHitCollectionIterator &)=default
CalorimeterHitCollectionIterator & operator=(CalorimeterHitCollectionIterator &&)=default
CalorimeterHitCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer *collection)
Definition CalorimeterHitCollection.h:47
CalorimeterHitCollectionIterator(CalorimeterHitCollectionIterator &&)=default
CalorimeterHit * pointer
Definition CalorimeterHitCollection.h:41
CalorimeterHitCollectionIterator & operator=(const CalorimeterHitCollectionIterator &)=default
std::input_iterator_tag iterator_category
Definition CalorimeterHitCollection.h:42
CalorimeterHitCollectionIterator & operator++()
Definition CalorimeterHitCollection.cc:377
CalorimeterHitCollectionIterator & operator-=(difference_type n)
Definition CalorimeterHitCollection.cc:414
std::random_access_iterator_tag iterator_concept
Definition CalorimeterHitCollection.h:45
auto operator<=>(const CalorimeterHitCollectionIterator &other) const
Definition CalorimeterHitCollection.h:56
CalorimeterHitCollectionIterator operator+(difference_type n) const
Definition CalorimeterHitCollection.cc:404
CalorimeterHit reference
Definition CalorimeterHitCollection.h:40
CalorimeterHitCollectionIterator operator-(difference_type n) const
Definition CalorimeterHitCollection.cc:419
bool operator==(const CalorimeterHitCollectionIterator &x) const
Definition CalorimeterHitCollection.h:60
reference operator[](difference_type n) const
Definition CalorimeterHitCollection.cc:425
ptrdiff_t difference_type
Definition CalorimeterHitCollection.h:39
reference operator*() const
Definition CalorimeterHitCollection.cc:368
CalorimeterHitCollectionIterator & operator+=(difference_type n)
Definition CalorimeterHitCollection.cc:399
CalorimeterHitCollectionIterator & operator--()
Definition CalorimeterHitCollection.cc:388
CalorimeterHit value_type
Definition CalorimeterHitCollection.h:38
pointer operator->()
Definition CalorimeterHitCollection.cc:372
Definition CalorimeterHit.h:46
Definition CalorimeterHitCollection.h:85
CalorimeterHitMutableCollectionIterator(const CalorimeterHitMutableCollectionIterator &)=default
CalorimeterHit value_type
Definition CalorimeterHitCollection.h:87
CalorimeterHitMutableCollectionIterator & operator++()
Definition CalorimeterHitCollection.cc:444
MutableCalorimeterHit * pointer
Definition CalorimeterHitCollection.h:90
reference operator[](difference_type n) const
Definition CalorimeterHitCollection.cc:492
CalorimeterHitMutableCollectionIterator operator+(difference_type n) const
Definition CalorimeterHitCollection.cc:471
CalorimeterHitMutableCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer *collection)
Definition CalorimeterHitCollection.h:96
bool operator==(const CalorimeterHitMutableCollectionIterator &x) const
Definition CalorimeterHitCollection.h:109
CalorimeterHitMutableCollectionIterator & operator=(const CalorimeterHitMutableCollectionIterator &)=default
CalorimeterHitMutableCollectionIterator & operator--()
Definition CalorimeterHitCollection.cc:455
auto operator<=>(const CalorimeterHitMutableCollectionIterator &other) const
Definition CalorimeterHitCollection.h:105
std::input_iterator_tag iterator_category
Definition CalorimeterHitCollection.h:91
MutableCalorimeterHit reference
Definition CalorimeterHitCollection.h:89
reference operator*() const
Definition CalorimeterHitCollection.cc:435
CalorimeterHitMutableCollectionIterator & operator=(CalorimeterHitMutableCollectionIterator &&)=default
ptrdiff_t difference_type
Definition CalorimeterHitCollection.h:88
std::random_access_iterator_tag iterator_concept
Definition CalorimeterHitCollection.h:94
pointer operator->()
Definition CalorimeterHitCollection.cc:439
CalorimeterHitMutableCollectionIterator(CalorimeterHitMutableCollectionIterator &&)=default
CalorimeterHitMutableCollectionIterator operator-(difference_type n) const
Definition CalorimeterHitCollection.cc:486
CalorimeterHitMutableCollectionIterator & operator+=(difference_type n)
Definition CalorimeterHitCollection.cc:466
CalorimeterHitMutableCollectionIterator & operator-=(difference_type n)
Definition CalorimeterHitCollection.cc:481
Definition CalorimeterHitObj.h:21
Definition MutableCalorimeterHit.h:38
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< CalorimeterHitObj * > CalorimeterHitObjPointerContainer
Definition CalorimeterHitCollectionData.h:23
Definition CalorimeterHit.h:31