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:
38 SimPulseCollectionIterator(size_t index, const SimPulseObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<SimPulseObj>{nullptr}), m_collection(collection) {}
39
42
44 return m_index != x.m_index; // TODO: may not be complete
45 }
46
48 return m_index == x.m_index; // TODO: may not be complete
49 }
50
54
55private:
56 size_t m_index;
57 SimPulse m_object;
58 const SimPulseObjPointerContainer* m_collection;
59};
60
61
63public:
64 SimPulseMutableCollectionIterator(size_t index, const SimPulseObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<SimPulseObj>{nullptr}), m_collection(collection) {}
65
68
70 return m_index != x.m_index; // TODO: may not be complete
71 }
72
74 return m_index == x.m_index; // TODO: may not be complete
75 }
76
80
81private:
82 size_t m_index;
83 MutableSimPulse m_object;
84 const SimPulseObjPointerContainer* m_collection;
85};
86
87
88/**
89A Collection is identified by an ID.
90*/
91class SimPulseCollection : public podio::CollectionBase {
92public:
96 using difference_type = ptrdiff_t;
97 using size_type = size_t;
98
100 SimPulseCollection(SimPulseCollectionData&& data, bool isSubsetColl);
101 // This is a move-only type
106
107// SimPulseCollection(SimPulseVector* data, uint32_t collectionID);
108 ~SimPulseCollection() override;
109
110 constexpr static auto typeName = "edm4eic::SimPulseCollection";
111 constexpr static auto valueTypeName = "edm4eic::SimPulse";
112 constexpr static auto dataTypeName = "edm4eic::SimPulseData";
113
114 void clear() final;
115
116 /// Print this collection to the passed stream
117 void print(std::ostream& os=std::cout, bool flush=true) const final;
118
119 /// operator to allow pointer like calling of members a la LCIO
120 SimPulseCollection* operator->() { return static_cast<SimPulseCollection*>(this); }
121
122 /// Append a new object to the collection, and return this object.
124
125 /// Append a new object to the collection, and return this object.
126 /// Initialized with the parameters given
127 template<typename... Args>
128 MutableSimPulse create(Args&&... args);
129
130 /// number of elements in the collection
131 std::size_t size() const final;
132
133 /// maximal number of elements in the collection
134 std::size_t max_size() const final;
135
136 /// Is the collection empty
137 bool empty() const final;
138
139 /// fully qualified type name
140 const std::string_view getTypeName() const final { return typeName; }
141 /// fully qualified type name of elements - with namespace
142 const std::string_view getValueTypeName() const final { return valueTypeName; }
143 /// fully qualified type name of stored POD elements - with namespace
144 const std::string_view getDataTypeName() const final { return dataTypeName; }
145 /// schema version
146 podio::SchemaVersionT getSchemaVersion() const final;
147
148 bool isSubsetCollection() const final {
149 return m_isSubsetColl;
150 }
151
152 void setSubsetCollection(bool setSubset=true) final;
153
154 /// Returns the const object of given index
155 SimPulse operator[](std::size_t index) const;
156 /// Returns the object of a given index
157 MutableSimPulse operator[](std::size_t index);
158 /// Returns the const object of given index
159 SimPulse at(std::size_t index) const;
160 /// Returns the object of given index
161 MutableSimPulse at(std::size_t index);
162
163
164 /// Append object to the collection
165 void push_back(const MutableSimPulse& object);
166 /// Append an object to the (subset) collection
167 void push_back(const SimPulse& object);
168
169 void prepareForWrite() const final;
170 void prepareAfterRead() final;
171 bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
172
173 /// Get the collection buffers for this collection
174 podio::CollectionWriteBuffers getBuffers() final;
175
176 void setID(uint32_t ID) final {
177 m_collectionID = ID;
178 if (!m_isSubsetColl) {
179 std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
180 [ID] (SimPulseObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
181 );
182 }
183 m_isValid = true;
184 }
185
186 uint32_t getID() const final {
187 return m_collectionID;
188 }
189
190 bool isValid() const final {
191 return m_isValid;
192 }
193
194 size_t getDatamodelRegistryIndex() const final;
195
196 // support for the iterator protocol
197 iterator begin() {
198 return iterator(0, &m_storage.entries);
199 }
201 return const_iterator(0, &m_storage.entries);
202 }
204 return begin();
205 }
207 return iterator(m_storage.entries.size(), &m_storage.entries);
208 }
210 return const_iterator(m_storage.entries.size(), &m_storage.entries);
211 }
213 return end();
214 }
215
216 std::vector<std::uint64_t> cellID(const size_t nElem = 0) const;
217 std::vector<float> integral(const size_t nElem = 0) const;
218 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
219 std::vector<float> time(const size_t nElem = 0) const;
220 std::vector<float> interval(const size_t nElem = 0) const;
221
222private:
223 // For setReferences, we need to give our own CollectionData access to our
224 // private entries. Otherwise we would need to expose a public member function
225 // that gives access to the Obj* which is definitely not what we want
227
228 bool m_isValid{false};
229 mutable bool m_isPrepared{false};
230 bool m_isSubsetColl{false};
231 uint32_t m_collectionID{0};
232 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
233 mutable SimPulseCollectionData m_storage{};
234};
235
236std::ostream& operator<<(std::ostream& o, const SimPulseCollection& v);
237
238template<typename... Args>
239MutableSimPulse SimPulseCollection::create(Args&&... args) {
240 if (m_isSubsetColl) {
241 throw std::logic_error("Cannot create new elements on a subset collection");
242 }
243 const int size = m_storage.entries.size();
244 auto obj = new SimPulseObj({size, m_collectionID}, {std::forward<Args>(args)...});
245 m_storage.entries.push_back(obj);
246
247 // Need to initialize the relation vectors manually for the {ObjectID, SimPulseData} constructor
248 obj->m_calorimeterHits = new std::vector<edm4hep::SimCalorimeterHit>();
249 obj->m_trackerHits = new std::vector<edm4hep::SimTrackerHit>();
250 obj->m_pulses = new std::vector<edm4eic::SimPulse>();
251 obj->m_particles = new std::vector<edm4hep::MCParticle>();
252 obj->m_amplitude = new std::vector<float>();
253 m_storage.createRelations(obj);
254 return MutableSimPulse(podio::utils::MaybeSharedPtr(obj));
255}
256
257#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
258void to_json(nlohmann::json& j, const SimPulseCollection& collection);
259#endif
260
261} // namespace edm4eic
262
263
264#endif
Definition MutableSimPulse.h:39
Definition SimPulseCollectionData.h:33
SimPulseObjPointerContainer entries
Definition SimPulseCollectionData.h:38
Definition SimPulseCollection.h:91
SimPulseCollection(const SimPulseCollection &)=delete
bool isValid() const final
Definition SimPulseCollection.h:190
~SimPulseCollection() override
Definition SimPulseCollection.cc:32
static constexpr auto dataTypeName
Definition SimPulseCollection.h:112
const_iterator cbegin() const
Definition SimPulseCollection.h:203
iterator end()
Definition SimPulseCollection.h:206
void clear() final
Definition SimPulseCollection.cc:88
void push_back(const MutableSimPulse &object)
Append object to the collection.
Definition SimPulseCollection.cc:133
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition SimPulseCollection.cc:225
static constexpr auto valueTypeName
Definition SimPulseCollection.h:111
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition SimPulseCollection.h:144
bool empty() const final
Is the collection empty.
Definition SimPulseCollection.cc:61
const_iterator cend() const
Definition SimPulseCollection.h:212
size_t size_type
Definition SimPulseCollection.h:97
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition SimPulseCollection.cc:129
SimPulseCollection(SimPulseCollection &&)=default
SimPulse at(std::size_t index) const
Returns the const object of given index.
Definition SimPulseCollection.cc:41
const std::string_view getTypeName() const final
fully qualified type name
Definition SimPulseCollection.h:140
std::size_t size() const final
number of elements in the collection
Definition SimPulseCollection.cc:53
void prepareForWrite() const final
Definition SimPulseCollection.cc:93
bool isSubsetCollection() const final
Definition SimPulseCollection.h:148
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition SimPulseCollection.cc:166
ptrdiff_t difference_type
Definition SimPulseCollection.h:96
SimPulseCollection & operator=(const SimPulseCollection &)=delete
std::size_t max_size() const final
maximal number of elements in the collection
Definition SimPulseCollection.cc:57
void setID(uint32_t ID) final
Definition SimPulseCollection.h:176
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition SimPulseCollection.h:142
static constexpr auto typeName
Definition SimPulseCollection.h:110
SimPulseCollection & operator=(SimPulseCollection &&)=default
const_iterator end() const
Definition SimPulseCollection.h:209
void setSubsetCollection(bool setSubset=true) final
Definition SimPulseCollection.cc:65
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition SimPulseCollection.cc:412
MutableSimPulse create()
Append a new object to the collection, and return this object.
Definition SimPulseCollection.cc:76
void prepareAfterRead() final
Definition SimPulseCollection.cc:114
const_iterator begin() const
Definition SimPulseCollection.h:200
SimPulseCollection()
Definition SimPulseCollection.cc:26
uint32_t getID() const final
Definition SimPulseCollection.h:186
Definition SimPulseCollection.h:36
SimPulseCollectionIterator(const SimPulseCollectionIterator &)=delete
SimPulse * operator->()
Definition SimPulseCollection.cc:336
SimPulseCollectionIterator(size_t index, const SimPulseObjPointerContainer *collection)
Definition SimPulseCollection.h:38
bool operator==(const SimPulseCollectionIterator &x) const
Definition SimPulseCollection.h:47
SimPulseCollectionIterator & operator++()
Definition SimPulseCollection.cc:341
SimPulse operator*()
Definition SimPulseCollection.cc:331
bool operator!=(const SimPulseCollectionIterator &x) const
Definition SimPulseCollection.h:43
SimPulseCollectionIterator & operator=(const SimPulseCollectionIterator &)=delete
Definition SimPulse.h:47
Definition SimPulseCollection.h:62
SimPulseMutableCollectionIterator & operator++()
Definition SimPulseCollection.cc:358
MutableSimPulse * operator->()
Definition SimPulseCollection.cc:353
bool operator==(const SimPulseMutableCollectionIterator &x) const
Definition SimPulseCollection.h:73
SimPulseMutableCollectionIterator(const SimPulseMutableCollectionIterator &)=delete
SimPulseMutableCollectionIterator(size_t index, const SimPulseObjPointerContainer *collection)
Definition SimPulseCollection.h:64
MutableSimPulse operator*()
Definition SimPulseCollection.cc:348
SimPulseMutableCollectionIterator & operator=(const SimPulseMutableCollectionIterator &)=delete
bool operator!=(const SimPulseMutableCollectionIterator &x) const
Definition SimPulseCollection.h:69
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