EDM4eic
EIC data model
Loading...
Searching...
No Matches
PMTHitCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_PMTHitCollection_H
4#define EDM4EIC_PMTHitCollection_H
5
6// datamodel specific includes
8#include "edm4eic/PMTHit.h"
10#include "edm4eic/PMTHitObj.h"
12
13// podio specific includes
14#include "podio/ICollectionProvider.h"
15#include "podio/CollectionBase.h"
16#include "podio/CollectionIDTable.h"
17
18#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
19#include "nlohmann/json_fwd.hpp"
20#endif
21
22#include <string>
23#include <vector>
24#include <deque>
25#include <array>
26#include <algorithm>
27#include <ostream>
28#include <mutex>
29#include <memory>
30#include <cstddef>
31
32namespace podio {
33 struct RelationNames;
34}
35
36namespace edm4eic {
37
38
39
41public:
42 PMTHitCollectionIterator(size_t index, const PMTHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<PMTHitObj>{nullptr}), m_collection(collection) {}
43
46
47 bool operator!=(const PMTHitCollectionIterator& x) const {
48 return m_index != x.m_index; // TODO: may not be complete
49 }
50
51 bool operator==(const PMTHitCollectionIterator& x) const {
52 return m_index == x.m_index; // TODO: may not be complete
53 }
54
58
59private:
60 size_t m_index;
61 PMTHit m_object;
62 const PMTHitObjPointerContainer* m_collection;
63};
64
65
67public:
68 PMTHitMutableCollectionIterator(size_t index, const PMTHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<PMTHitObj>{nullptr}), m_collection(collection) {}
69
72
74 return m_index != x.m_index; // TODO: may not be complete
75 }
76
78 return m_index == x.m_index; // TODO: may not be complete
79 }
80
84
85private:
86 size_t m_index;
87 MutablePMTHit m_object;
88 const PMTHitObjPointerContainer* m_collection;
89};
90
91
92/**
93A Collection is identified by an ID.
94*/
95class PMTHitCollection : public podio::CollectionBase {
96public:
100
102 PMTHitCollection(PMTHitCollectionData&& data, bool isSubsetColl);
103 // This is a move-only type
108
109// PMTHitCollection(PMTHitVector* data, uint32_t collectionID);
111
112 constexpr static auto typeName = "edm4eic::PMTHitCollection";
113 constexpr static auto valueTypeName = "edm4eic::PMTHit";
114 constexpr static auto dataTypeName = "edm4eic::PMTHitData";
115
116 void clear() final;
117
118 /// Print this collection to the passed stream
119 void print(std::ostream& os=std::cout, bool flush=true) const final;
120
121 /// operator to allow pointer like calling of members a la LCIO
122 PMTHitCollection* operator->() { return (PMTHitCollection*) this; }
123
124 /// Append a new object to the collection, and return this object.
126
127 /// Append a new object to the collection, and return this object.
128 /// Initialized with the parameters given
129 template<typename... Args>
130 MutablePMTHit create(Args&&... args);
131
132 /// number of elements in the collection
133 std::size_t size() const final;
134
135 /// Is the collection empty
136 bool empty() const final;
137
138 /// fully qualified type name
139 const std::string_view getTypeName() const final { return typeName; }
140 /// fully qualified type name of elements - with namespace
141 const std::string_view getValueTypeName() const final { return valueTypeName; }
142 /// fully qualified type name of stored POD elements - with namespace
143 const std::string_view getDataTypeName() const final { return dataTypeName; }
144 /// schema version
145 podio::SchemaVersionT getSchemaVersion() const final;
146
147 bool isSubsetCollection() const final {
148 return m_isSubsetColl;
149 }
150
151 void setSubsetCollection(bool setSubset=true) final;
152
153 /// Returns the const object of given index
154 PMTHit operator[](std::size_t index) const;
155 /// Returns the object of a given index
156 MutablePMTHit operator[](std::size_t index);
157 /// Returns the const object of given index
158 PMTHit at(std::size_t index) const;
159 /// Returns the object of given index
160 MutablePMTHit at(std::size_t index);
161
162
163 /// Append object to the collection
164 void push_back(MutablePMTHit object);
165 /// Append an object to the (subset) collection
166 void push_back(PMTHit object);
167
168 void prepareForWrite() const final;
169 void prepareAfterRead() final;
170 bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
171
172 /// Get the collection buffers for this collection
173 podio::CollectionWriteBuffers getBuffers() final;
174
175 void setID(uint32_t ID) final {
176 m_collectionID = ID;
177 if (!m_isSubsetColl) {
178 std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
179 [ID] (PMTHitObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
180 );
181 }
182 m_isValid = true;
183 };
184
185 uint32_t getID() const final {
186 return m_collectionID;
187 }
188
189 bool isValid() const final {
190 return m_isValid;
191 }
192
193 size_t getDatamodelRegistryIndex() const final;
194
195 // support for the iterator protocol
196 iterator begin() {
197 return iterator(0, &m_storage.entries);
198 }
200 return const_iterator(0, &m_storage.entries);
201 }
203 return iterator(m_storage.entries.size(), &m_storage.entries);
204 }
206 return const_iterator(m_storage.entries.size(), &m_storage.entries);
207 }
208
209 std::vector<std::uint64_t> cellID(const size_t nElem = 0) const;
210 std::vector<float> npe(const size_t nElem = 0) const;
211 std::vector<float> time(const size_t nElem = 0) const;
212 std::vector<float> timeError(const size_t nElem = 0) const;
213 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
214 std::vector<edm4hep::Vector3f> dimension(const size_t nElem = 0) const;
215 std::vector<std::int32_t> sector(const size_t nElem = 0) const;
216 std::vector<edm4hep::Vector3f> local(const size_t nElem = 0) const;
217
218private:
219 // For setReferences, we need to give our own CollectionData access to our
220 // private entries. Otherwise we would need to expose a public member function
221 // that gives access to the Obj* which is definitely not what we want
223
224 bool m_isValid{false};
225 mutable bool m_isPrepared{false};
226 bool m_isSubsetColl{false};
227 uint32_t m_collectionID{0};
228 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
229 mutable PMTHitCollectionData m_storage{};
230};
231
232std::ostream& operator<<(std::ostream& o, const PMTHitCollection& v);
233
234template<typename... Args>
235MutablePMTHit PMTHitCollection::create(Args&&... args) {
236 if (m_isSubsetColl) {
237 throw std::logic_error("Cannot create new elements on a subset collection");
238 }
239 const int size = m_storage.entries.size();
240 auto obj = new PMTHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
241 m_storage.entries.push_back(obj);
242
243 return MutablePMTHit(podio::utils::MaybeSharedPtr(obj));
244}
245
246#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
247void to_json(nlohmann::json& j, const PMTHitCollection& collection);
248#endif
249
250} // namespace edm4eic
251
252
253#endif
Definition MutablePMTHit.h:31
Definition PMTHitCollectionData.h:30
PMTHitObjPointerContainer entries
Definition PMTHitCollectionData.h:35
Definition PMTHitCollection.h:95
std::size_t size() const final
number of elements in the collection
Definition PMTHitCollection.cc:49
void clear() final
Definition PMTHitCollection.cc:79
PMTHit at(std::size_t index) const
Returns the const object of given index.
Definition PMTHitCollection.cc:37
const_iterator begin() const
Definition PMTHitCollection.h:199
bool empty() const final
Is the collection empty.
Definition PMTHitCollection.cc:53
void setID(uint32_t ID) final
Definition PMTHitCollection.h:175
uint32_t getID() const final
Definition PMTHitCollection.h:185
PMTHitCollection(const PMTHitCollection &)=delete
PMTHitCollection & operator=(PMTHitCollection &&)=default
void push_back(MutablePMTHit object)
Append object to the collection.
Definition PMTHitCollection.cc:124
iterator end()
Definition PMTHitCollection.h:202
static constexpr auto typeName
Definition PMTHitCollection.h:112
PMTHitCollection()
Definition PMTHitCollection.cc:22
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition PMTHitCollection.h:143
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition PMTHitCollection.cc:156
void prepareForWrite() const final
Definition PMTHitCollection.cc:84
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition PMTHitCollection.h:141
bool isValid() const final
Definition PMTHitCollection.h:189
const std::string_view getTypeName() const final
fully qualified type name
Definition PMTHitCollection.h:139
void prepareAfterRead() final
Definition PMTHitCollection.cc:105
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition PMTHitCollection.cc:402
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition PMTHitCollection.cc:245
PMTHitCollection & operator=(const PMTHitCollection &)=delete
static constexpr auto valueTypeName
Definition PMTHitCollection.h:113
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition PMTHitCollection.cc:120
const_iterator end() const
Definition PMTHitCollection.h:205
void setSubsetCollection(bool setSubset=true) final
Definition PMTHitCollection.cc:57
static constexpr auto dataTypeName
Definition PMTHitCollection.h:114
MutablePMTHit create()
Append a new object to the collection, and return this object.
Definition PMTHitCollection.cc:68
bool isSubsetCollection() const final
Definition PMTHitCollection.h:147
~PMTHitCollection()
Definition PMTHitCollection.cc:28
PMTHitCollection(PMTHitCollection &&)=default
Definition PMTHitCollection.h:40
bool operator!=(const PMTHitCollectionIterator &x) const
Definition PMTHitCollection.h:47
PMTHitCollectionIterator & operator++()
Definition PMTHitCollection.cc:353
bool operator==(const PMTHitCollectionIterator &x) const
Definition PMTHitCollection.h:51
PMTHitCollectionIterator(size_t index, const PMTHitObjPointerContainer *collection)
Definition PMTHitCollection.h:42
PMTHitCollectionIterator(const PMTHitCollectionIterator &)=delete
PMTHit * operator->()
Definition PMTHitCollection.cc:348
PMTHit operator*()
Definition PMTHitCollection.cc:343
PMTHitCollectionIterator & operator=(const PMTHitCollectionIterator &)=delete
Definition PMTHit.h:32
Definition PMTHitCollection.h:66
PMTHitMutableCollectionIterator(const PMTHitMutableCollectionIterator &)=delete
PMTHitMutableCollectionIterator & operator++()
Definition PMTHitCollection.cc:370
bool operator!=(const PMTHitMutableCollectionIterator &x) const
Definition PMTHitCollection.h:73
PMTHitMutableCollectionIterator(size_t index, const PMTHitObjPointerContainer *collection)
Definition PMTHitCollection.h:68
MutablePMTHit operator*()
Definition PMTHitCollection.cc:360
MutablePMTHit * operator->()
Definition PMTHitCollection.cc:365
PMTHitMutableCollectionIterator & operator=(const PMTHitMutableCollectionIterator &)=delete
bool operator==(const PMTHitMutableCollectionIterator &x) const
Definition PMTHitCollection.h:77
Definition PMTHitObj.h:17
Definition CalorimeterHit.cc:18
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:97
std::deque< PMTHitObj * > PMTHitObjPointerContainer
Definition PMTHitCollectionData.h:22
Definition CalorimeterHitCollection.h:32