EDM4eic
EIC data model
Loading...
Searching...
No Matches
CherenkovParticleIDCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_CherenkovParticleIDCollection_H
4#define EDM4EIC_CherenkovParticleIDCollection_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:
38 CherenkovParticleIDCollectionIterator(size_t index, const CherenkovParticleIDObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<CherenkovParticleIDObj>{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 CherenkovParticleID m_object;
59};
60
61
63public:
64 CherenkovParticleIDMutableCollectionIterator(size_t index, const CherenkovParticleIDObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<CherenkovParticleIDObj>{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;
85};
86
87
88/**
89A Collection is identified by an ID.
90*/
91class CherenkovParticleIDCollection : public podio::CollectionBase {
92public:
96 using difference_type = ptrdiff_t;
97 using size_type = size_t;
98
101 // This is a move-only type
106
107// CherenkovParticleIDCollection(CherenkovParticleIDVector* data, uint32_t collectionID);
109
110 constexpr static auto typeName = "edm4eic::CherenkovParticleIDCollection";
111 constexpr static auto valueTypeName = "edm4eic::CherenkovParticleID";
112 constexpr static auto dataTypeName = "edm4eic::CherenkovParticleIDData";
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 CherenkovParticleIDCollection* operator->() { return static_cast<CherenkovParticleIDCollection*>(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 MutableCherenkovParticleID 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 CherenkovParticleID operator[](std::size_t index) const;
156 /// Returns the object of a given index
157 MutableCherenkovParticleID operator[](std::size_t index);
158 /// Returns the const object of given index
159 CherenkovParticleID at(std::size_t index) const;
160 /// Returns the object of given index
161 MutableCherenkovParticleID at(std::size_t index);
162
163
164 /// Append object to the collection
165 void push_back(const MutableCherenkovParticleID& object);
166 /// Append an object to the (subset) collection
167 void push_back(const CherenkovParticleID& 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] (CherenkovParticleIDObj* 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<float> npe(const size_t nElem = 0) const;
217 std::vector<float> refractiveIndex(const size_t nElem = 0) const;
218 std::vector<float> photonEnergy(const size_t nElem = 0) const;
219
220private:
221 // For setReferences, we need to give our own CollectionData access to our
222 // private entries. Otherwise we would need to expose a public member function
223 // that gives access to the Obj* which is definitely not what we want
225
226 bool m_isValid{false};
227 mutable bool m_isPrepared{false};
228 bool m_isSubsetColl{false};
229 uint32_t m_collectionID{0};
230 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
231 mutable CherenkovParticleIDCollectionData m_storage{};
232};
233
234std::ostream& operator<<(std::ostream& o, const CherenkovParticleIDCollection& v);
235
236template<typename... Args>
237MutableCherenkovParticleID CherenkovParticleIDCollection::create(Args&&... args) {
238 if (m_isSubsetColl) {
239 throw std::logic_error("Cannot create new elements on a subset collection");
240 }
241 const int size = m_storage.entries.size();
242 auto obj = new CherenkovParticleIDObj({size, m_collectionID}, {std::forward<Args>(args)...});
243 m_storage.entries.push_back(obj);
244
245 // Need to initialize the relation vectors manually for the {ObjectID, CherenkovParticleIDData} constructor
246 obj->m_rawHitAssociations = new std::vector<edm4eic::MCRecoTrackerHitAssociation>();
247 obj->m_hypotheses = new std::vector<edm4eic::CherenkovParticleIDHypothesis>();
248 obj->m_thetaPhiPhotons = new std::vector<edm4hep::Vector2f>();
249 m_storage.createRelations(obj);
250 return MutableCherenkovParticleID(podio::utils::MaybeSharedPtr(obj));
251}
252
253#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
254void to_json(nlohmann::json& j, const CherenkovParticleIDCollection& collection);
255#endif
256
257} // namespace edm4eic
258
259
260#endif
Definition CherenkovParticleIDCollectionData.h:32
CherenkovParticleIDObjPointerContainer entries
Definition CherenkovParticleIDCollectionData.h:37
Definition CherenkovParticleIDCollection.h:91
void push_back(const MutableCherenkovParticleID &object)
Append object to the collection.
Definition CherenkovParticleIDCollection.cc:132
void clear() final
Definition CherenkovParticleIDCollection.cc:87
CherenkovParticleIDCollection()
Definition CherenkovParticleIDCollection.cc:25
const_iterator begin() const
Definition CherenkovParticleIDCollection.h:200
const_iterator end() const
Definition CherenkovParticleIDCollection.h:209
bool isValid() const final
Definition CherenkovParticleIDCollection.h:190
CherenkovParticleIDCollection & operator=(CherenkovParticleIDCollection &&)=default
void prepareForWrite() const final
Definition CherenkovParticleIDCollection.cc:92
void setID(uint32_t ID) final
Definition CherenkovParticleIDCollection.h:176
uint32_t getID() const final
Definition CherenkovParticleIDCollection.h:186
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition CherenkovParticleIDCollection.cc:165
const_iterator cbegin() const
Definition CherenkovParticleIDCollection.h:203
void setSubsetCollection(bool setSubset=true) final
Definition CherenkovParticleIDCollection.cc:64
std::size_t size() const final
number of elements in the collection
Definition CherenkovParticleIDCollection.cc:52
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition CherenkovParticleIDCollection.cc:384
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition CherenkovParticleIDCollection.cc:128
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition CherenkovParticleIDCollection.h:144
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition CherenkovParticleIDCollection.h:142
const std::string_view getTypeName() const final
fully qualified type name
Definition CherenkovParticleIDCollection.h:140
MutableCherenkovParticleID create()
Append a new object to the collection, and return this object.
Definition CherenkovParticleIDCollection.cc:75
std::size_t max_size() const final
maximal number of elements in the collection
Definition CherenkovParticleIDCollection.cc:56
CherenkovParticleIDCollection(CherenkovParticleIDCollection &&)=default
CherenkovParticleID at(std::size_t index) const
Returns the const object of given index.
Definition CherenkovParticleIDCollection.cc:40
~CherenkovParticleIDCollection() override
Definition CherenkovParticleIDCollection.cc:31
void prepareAfterRead() final
Definition CherenkovParticleIDCollection.cc:113
static constexpr auto valueTypeName
Definition CherenkovParticleIDCollection.h:111
CherenkovParticleIDCollection(const CherenkovParticleIDCollection &)=delete
const_iterator cend() const
Definition CherenkovParticleIDCollection.h:212
size_t size_type
Definition CherenkovParticleIDCollection.h:97
static constexpr auto typeName
Definition CherenkovParticleIDCollection.h:110
ptrdiff_t difference_type
Definition CherenkovParticleIDCollection.h:96
bool isSubsetCollection() const final
Definition CherenkovParticleIDCollection.h:148
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition CherenkovParticleIDCollection.cc:204
iterator end()
Definition CherenkovParticleIDCollection.h:206
CherenkovParticleIDCollection & operator=(const CherenkovParticleIDCollection &)=delete
bool empty() const final
Is the collection empty.
Definition CherenkovParticleIDCollection.cc:60
static constexpr auto dataTypeName
Definition CherenkovParticleIDCollection.h:112
Definition CherenkovParticleIDCollection.h:36
bool operator!=(const CherenkovParticleIDCollectionIterator &x) const
Definition CherenkovParticleIDCollection.h:43
bool operator==(const CherenkovParticleIDCollectionIterator &x) const
Definition CherenkovParticleIDCollection.h:47
CherenkovParticleID * operator->()
Definition CherenkovParticleIDCollection.cc:318
CherenkovParticleIDCollectionIterator(const CherenkovParticleIDCollectionIterator &)=delete
CherenkovParticleID operator*()
Definition CherenkovParticleIDCollection.cc:313
CherenkovParticleIDCollectionIterator(size_t index, const CherenkovParticleIDObjPointerContainer *collection)
Definition CherenkovParticleIDCollection.h:38
CherenkovParticleIDCollectionIterator & operator++()
Definition CherenkovParticleIDCollection.cc:323
CherenkovParticleIDCollectionIterator & operator=(const CherenkovParticleIDCollectionIterator &)=delete
Definition CherenkovParticleID.h:46
Definition CherenkovParticleIDCollection.h:62
CherenkovParticleIDMutableCollectionIterator & operator++()
Definition CherenkovParticleIDCollection.cc:340
bool operator!=(const CherenkovParticleIDMutableCollectionIterator &x) const
Definition CherenkovParticleIDCollection.h:69
bool operator==(const CherenkovParticleIDMutableCollectionIterator &x) const
Definition CherenkovParticleIDCollection.h:73
CherenkovParticleIDMutableCollectionIterator(size_t index, const CherenkovParticleIDObjPointerContainer *collection)
Definition CherenkovParticleIDCollection.h:64
CherenkovParticleIDMutableCollectionIterator & operator=(const CherenkovParticleIDMutableCollectionIterator &)=delete
MutableCherenkovParticleID * operator->()
Definition CherenkovParticleIDCollection.cc:335
CherenkovParticleIDMutableCollectionIterator(const CherenkovParticleIDMutableCollectionIterator &)=delete
MutableCherenkovParticleID operator*()
Definition CherenkovParticleIDCollection.cc:330
Definition CherenkovParticleIDObj.h:26
std::vector< edm4eic::MCRecoTrackerHitAssociation > * m_rawHitAssociations
Definition CherenkovParticleIDObj.h:43
Definition MutableCherenkovParticleID.h:38
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< CherenkovParticleIDObj * > CherenkovParticleIDObjPointerContainer
Definition CherenkovParticleIDCollectionData.h:24
Definition CalorimeterHit.h:31