EDM4eic
EIC data model
Loading...
Searching...
No Matches
SimPulseCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_SimPulseCollection_H
4#define EDM4EIC_SimPulseCollection_H
5
6// datamodel specific includes
7#include "edm4eic/SimPulse.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;
41 using pointer = SimPulse*;
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 SimPulseCollectionIterator(size_t index, const SimPulseObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<SimPulseObj>{nullptr}), m_collection(collection) {}
49
55
56 auto operator<=>(const SimPulseCollectionIterator& 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 SimPulse m_object { podio::utils::MaybeSharedPtr<SimPulseObj>{nullptr} };
81 const SimPulseObjPointerContainer* 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 SimPulseMutableCollectionIterator(size_t index, const SimPulseObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<SimPulseObj>{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 MutableSimPulse m_object { podio::utils::MaybeSharedPtr<SimPulseObj>{nullptr} };
130 const SimPulseObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class SimPulseCollection : 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 SimPulseCollection(SimPulseCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// SimPulseCollection(SimPulseVector* data, uint32_t collectionID);
157 ~SimPulseCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::SimPulseCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::SimPulse";
161 constexpr static std::string_view dataTypeName = "edm4eic::SimPulseData";
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 SimPulseCollection* operator->() { return static_cast<SimPulseCollection*>(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 MutableSimPulse 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 SimPulse operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableSimPulse operator[](std::size_t index);
207 /// Returns the const object of given index
208 SimPulse at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableSimPulse at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableSimPulse& object);
215 /// Append an object to the (subset) collection
216 void push_back(const SimPulse& 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] (SimPulseObj* 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> integral(const size_t nElem = 0) const;
287 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
288 std::vector<float> time(const size_t nElem = 0) const;
289 std::vector<float> interval(const size_t nElem = 0) const;
290
291private:
292 // For setReferences, we need to give our own CollectionData access to our
293 // private entries. Otherwise we would need to expose a public member function
294 // that gives access to the Obj* which is definitely not what we want
296
297 bool m_isValid{false};
298 mutable bool m_isPrepared{false};
299 bool m_isSubsetColl{false};
300 uint32_t m_collectionID{0};
301 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
302 mutable SimPulseCollectionData m_storage{};
303};
304
305std::ostream& operator<<(std::ostream& o, const SimPulseCollection& v);
306
307template<typename... Args>
309 if (m_isSubsetColl) {
310 throw std::logic_error("Cannot create new elements on a subset collection");
311 }
312 const int size = m_storage.entries.size();
313 auto obj = new SimPulseObj({size, m_collectionID}, {std::forward<Args>(args)...});
314 m_storage.entries.push_back(obj);
315
316 // Need to initialize the relation vectors manually for the {ObjectID, SimPulseData} constructor
317 obj->m_calorimeterHits = new std::vector<edm4hep::SimCalorimeterHit>();
318 obj->m_trackerHits = new std::vector<edm4hep::SimTrackerHit>();
319 obj->m_pulses = new std::vector<edm4eic::SimPulse>();
320 obj->m_particles = new std::vector<edm4hep::MCParticle>();
321 obj->m_amplitude = new std::vector<float>();
322 m_storage.createRelations(obj);
323 return MutableSimPulse(podio::utils::MaybeSharedPtr(obj));
324}
325
326#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
327void to_json(nlohmann::json& j, const SimPulseCollection& collection);
328#endif
329
330} // namespace edm4eic
331
332
333#endif
Definition MutableSimPulse.h:39
Definition SimPulseCollectionData.h:33
Definition SimPulseCollection.h:137
SimPulseCollection(const SimPulseCollection &)=delete
const_reverse_iterator rend() const
Definition SimPulseCollection.h:277
friend class SimPulseCollectionData
Definition SimPulseCollection.h:295
bool isValid() const final
Definition SimPulseCollection.h:239
~SimPulseCollection() override
Definition SimPulseCollection.cc:33
SimPulse value_type
Definition SimPulseCollection.h:139
reverse_iterator rend()
Definition SimPulseCollection.h:274
const_iterator cbegin() const
Definition SimPulseCollection.h:252
iterator end()
Definition SimPulseCollection.h:255
void clear() final
Definition SimPulseCollection.cc:95
void push_back(const MutableSimPulse &object)
Append object to the collection.
Definition SimPulseCollection.cc:128
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition SimPulseCollection.cc:220
static constexpr std::string_view dataTypeName
Definition SimPulseCollection.h:161
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition SimPulseCollection.h:193
bool empty() const final
Is the collection empty.
Definition SimPulseCollection.cc:68
const_iterator cend() const
Definition SimPulseCollection.h:261
size_t size_type
Definition SimPulseCollection.h:144
MutableSimPulse mutable_type
Definition SimPulseCollection.h:140
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition SimPulseCollection.cc:124
SimPulseMutableCollectionIterator iterator
Definition SimPulseCollection.h:142
iterator begin()
Definition SimPulseCollection.h:246
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition SimPulseCollection.h:145
SimPulseCollection(SimPulseCollection &&)=default
SimPulse at(std::size_t index) const
Returns the const object of given index.
Definition SimPulseCollection.cc:42
static constexpr std::string_view valueTypeName
Definition SimPulseCollection.h:160
const std::string_view getTypeName() const final
fully qualified type name
Definition SimPulseCollection.h:189
std::size_t size() const final
number of elements in the collection
Definition SimPulseCollection.cc:54
void prepareForWrite() const final
Definition SimPulseCollection.cc:100
bool isSubsetCollection() const final
Definition SimPulseCollection.h:197
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition SimPulseCollection.cc:161
ptrdiff_t difference_type
Definition SimPulseCollection.h:143
const_reverse_iterator crend() const
Definition SimPulseCollection.h:280
SimPulseCollection & operator=(const SimPulseCollection &)=delete
std::size_t max_size() const final
maximal number of elements in the collection
Definition SimPulseCollection.cc:58
void setID(uint32_t ID) final
Definition SimPulseCollection.h:225
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition SimPulseCollection.h:191
SimPulseCollection & operator=(SimPulseCollection &&)=default
const_iterator end() const
Definition SimPulseCollection.h:258
const_reverse_iterator rbegin() const
Definition SimPulseCollection.h:268
void setSubsetCollection(bool setSubset=true) final
Definition SimPulseCollection.cc:72
static constexpr std::string_view typeName
Definition SimPulseCollection.h:159
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition SimPulseCollection.cc:507
SimPulseCollectionIterator const_iterator
Definition SimPulseCollection.h:141
MutableSimPulse create()
Append a new object to the collection, and return this object.
Definition SimPulseCollection.cc:83
std::reverse_iterator< iterator > reverse_iterator
Definition SimPulseCollection.h:146
reverse_iterator rbegin()
Definition SimPulseCollection.h:265
void prepareAfterRead() final
Definition SimPulseCollection.cc:109
const_iterator begin() const
Definition SimPulseCollection.h:249
SimPulseCollection()
Definition SimPulseCollection.cc:27
const_reverse_iterator crbegin() const
Definition SimPulseCollection.h:271
uint32_t getID() const final
Definition SimPulseCollection.h:235
Definition SimPulseCollection.h:36
SimPulseCollectionIterator & operator+=(difference_type n)
Definition SimPulseCollection.cc:357
pointer operator->()
Definition SimPulseCollection.cc:330
SimPulse value_type
Definition SimPulseCollection.h:38
SimPulse reference
Definition SimPulseCollection.h:40
reference operator*() const
Definition SimPulseCollection.cc:326
std::input_iterator_tag iterator_category
Definition SimPulseCollection.h:42
SimPulseCollectionIterator & operator--()
Definition SimPulseCollection.cc:346
auto operator<=>(const SimPulseCollectionIterator &other) const
Definition SimPulseCollection.h:56
reference operator[](difference_type n) const
Definition SimPulseCollection.cc:383
SimPulseCollectionIterator operator-(difference_type n) const
Definition SimPulseCollection.cc:377
SimPulseCollectionIterator & operator=(SimPulseCollectionIterator &&)=default
ptrdiff_t difference_type
Definition SimPulseCollection.h:39
SimPulseCollectionIterator(size_t index, const SimPulseObjPointerContainer *collection)
Definition SimPulseCollection.h:47
SimPulseCollectionIterator(const SimPulseCollectionIterator &)=default
bool operator==(const SimPulseCollectionIterator &x) const
Definition SimPulseCollection.h:60
SimPulseCollectionIterator(SimPulseCollectionIterator &&)=default
SimPulseCollectionIterator & operator=(const SimPulseCollectionIterator &)=default
SimPulseCollectionIterator & operator++()
Definition SimPulseCollection.cc:335
SimPulseCollectionIterator & operator-=(difference_type n)
Definition SimPulseCollection.cc:372
SimPulseCollectionIterator operator+(difference_type n) const
Definition SimPulseCollection.cc:362
SimPulse * pointer
Definition SimPulseCollection.h:41
std::random_access_iterator_tag iterator_concept
Definition SimPulseCollection.h:45
Definition SimPulse.h:47
Definition SimPulseCollection.h:85
SimPulseMutableCollectionIterator & operator++()
Definition SimPulseCollection.cc:402
SimPulse value_type
Definition SimPulseCollection.h:87
pointer operator->()
Definition SimPulseCollection.cc:397
SimPulseMutableCollectionIterator & operator=(SimPulseMutableCollectionIterator &&)=default
SimPulseMutableCollectionIterator & operator--()
Definition SimPulseCollection.cc:413
SimPulseMutableCollectionIterator & operator-=(difference_type n)
Definition SimPulseCollection.cc:439
std::input_iterator_tag iterator_category
Definition SimPulseCollection.h:91
SimPulseMutableCollectionIterator(SimPulseMutableCollectionIterator &&)=default
MutableSimPulse reference
Definition SimPulseCollection.h:89
bool operator==(const SimPulseMutableCollectionIterator &x) const
Definition SimPulseCollection.h:109
SimPulseMutableCollectionIterator & operator+=(difference_type n)
Definition SimPulseCollection.cc:424
std::random_access_iterator_tag iterator_concept
Definition SimPulseCollection.h:94
reference operator*() const
Definition SimPulseCollection.cc:393
SimPulseMutableCollectionIterator operator+(difference_type n) const
Definition SimPulseCollection.cc:429
auto operator<=>(const SimPulseMutableCollectionIterator &other) const
Definition SimPulseCollection.h:105
SimPulseMutableCollectionIterator(const SimPulseMutableCollectionIterator &)=default
MutableSimPulse * pointer
Definition SimPulseCollection.h:90
SimPulseMutableCollectionIterator(size_t index, const SimPulseObjPointerContainer *collection)
Definition SimPulseCollection.h:96
ptrdiff_t difference_type
Definition SimPulseCollection.h:88
reference operator[](difference_type n) const
Definition SimPulseCollection.cc:450
SimPulseMutableCollectionIterator operator-(difference_type n) const
Definition SimPulseCollection.cc:444
SimPulseMutableCollectionIterator & operator=(const SimPulseMutableCollectionIterator &)=default
Definition SimPulseObj.h:22
std::vector< edm4hep::SimCalorimeterHit > * m_calorimeterHits
Definition SimPulseObj.h:38
Definition CalorimeterHit.cc:17
std::deque< SimPulseObj * > SimPulseObjPointerContainer
Definition SimPulseCollectionData.h:25
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:31