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
7#include "edm4eic/PMTHit.h"
9#include "edm4eic/PMTHitObj.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 PMTHitCollectionIterator(size_t index, const PMTHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<PMTHitObj>{nullptr}), m_collection(collection) {}
39
42
43 bool operator!=(const PMTHitCollectionIterator& x) const {
44 return m_index != x.m_index; // TODO: may not be complete
45 }
46
47 bool operator==(const PMTHitCollectionIterator& x) const {
48 return m_index == x.m_index; // TODO: may not be complete
49 }
50
54
55private:
56 size_t m_index;
57 PMTHit m_object;
58 const PMTHitObjPointerContainer* m_collection;
59};
60
61
63public:
64 PMTHitMutableCollectionIterator(size_t index, const PMTHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<PMTHitObj>{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 MutablePMTHit m_object;
84 const PMTHitObjPointerContainer* m_collection;
85};
86
87
88/**
89A Collection is identified by an ID.
90*/
91class PMTHitCollection : public podio::CollectionBase {
92public:
96 using difference_type = ptrdiff_t;
97 using size_type = size_t;
98
100 PMTHitCollection(PMTHitCollectionData&& data, bool isSubsetColl);
101 // This is a move-only type
106
107// PMTHitCollection(PMTHitVector* data, uint32_t collectionID);
108 ~PMTHitCollection() override;
109
110 constexpr static auto typeName = "edm4eic::PMTHitCollection";
111 constexpr static auto valueTypeName = "edm4eic::PMTHit";
112 constexpr static auto dataTypeName = "edm4eic::PMTHitData";
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 PMTHitCollection* operator->() { return static_cast<PMTHitCollection*>(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 MutablePMTHit 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 PMTHit operator[](std::size_t index) const;
156 /// Returns the object of a given index
157 MutablePMTHit operator[](std::size_t index);
158 /// Returns the const object of given index
159 PMTHit at(std::size_t index) const;
160 /// Returns the object of given index
161 MutablePMTHit at(std::size_t index);
162
163
164 /// Append object to the collection
165 void push_back(const MutablePMTHit& object);
166 /// Append an object to the (subset) collection
167 void push_back(const PMTHit& 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] (PMTHitObj* 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> npe(const size_t nElem = 0) const;
218 std::vector<float> time(const size_t nElem = 0) const;
219 std::vector<float> timeError(const size_t nElem = 0) const;
220 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
221 std::vector<edm4hep::Vector3f> dimension(const size_t nElem = 0) const;
222 std::vector<std::int32_t> sector(const size_t nElem = 0) const;
223 std::vector<edm4hep::Vector3f> local(const size_t nElem = 0) const;
224
225private:
226 // For setReferences, we need to give our own CollectionData access to our
227 // private entries. Otherwise we would need to expose a public member function
228 // that gives access to the Obj* which is definitely not what we want
230
231 bool m_isValid{false};
232 mutable bool m_isPrepared{false};
233 bool m_isSubsetColl{false};
234 uint32_t m_collectionID{0};
235 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
236 mutable PMTHitCollectionData m_storage{};
237};
238
239std::ostream& operator<<(std::ostream& o, const PMTHitCollection& v);
240
241template<typename... Args>
242MutablePMTHit PMTHitCollection::create(Args&&... args) {
243 if (m_isSubsetColl) {
244 throw std::logic_error("Cannot create new elements on a subset collection");
245 }
246 const int size = m_storage.entries.size();
247 auto obj = new PMTHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
248 m_storage.entries.push_back(obj);
249
250 return MutablePMTHit(podio::utils::MaybeSharedPtr(obj));
251}
252
253#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
254void to_json(nlohmann::json& j, const PMTHitCollection& collection);
255#endif
256
257} // namespace edm4eic
258
259
260#endif
Definition MutablePMTHit.h:34
Definition PMTHitCollectionData.h:30
PMTHitObjPointerContainer entries
Definition PMTHitCollectionData.h:35
Definition PMTHitCollection.h:91
std::size_t size() const final
number of elements in the collection
Definition PMTHitCollection.cc:49
void clear() final
Definition PMTHitCollection.cc:83
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:200
const_iterator cbegin() const
Definition PMTHitCollection.h:203
bool empty() const final
Is the collection empty.
Definition PMTHitCollection.cc:57
void setID(uint32_t ID) final
Definition PMTHitCollection.h:176
~PMTHitCollection() override
Definition PMTHitCollection.cc:28
uint32_t getID() const final
Definition PMTHitCollection.h:186
PMTHitCollection(const PMTHitCollection &)=delete
PMTHitCollection & operator=(PMTHitCollection &&)=default
iterator end()
Definition PMTHitCollection.h:206
size_t size_type
Definition PMTHitCollection.h:97
static constexpr auto typeName
Definition PMTHitCollection.h:110
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:144
std::size_t max_size() const final
maximal number of elements in the collection
Definition PMTHitCollection.cc:53
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition PMTHitCollection.cc:160
void prepareForWrite() const final
Definition PMTHitCollection.cc:88
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition PMTHitCollection.h:142
ptrdiff_t difference_type
Definition PMTHitCollection.h:96
bool isValid() const final
Definition PMTHitCollection.h:190
const std::string_view getTypeName() const final
fully qualified type name
Definition PMTHitCollection.h:140
void prepareAfterRead() final
Definition PMTHitCollection.cc:109
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition PMTHitCollection.cc:411
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition PMTHitCollection.cc:249
void push_back(const MutablePMTHit &object)
Append object to the collection.
Definition PMTHitCollection.cc:128
PMTHitCollection & operator=(const PMTHitCollection &)=delete
static constexpr auto valueTypeName
Definition PMTHitCollection.h:111
const_iterator cend() const
Definition PMTHitCollection.h:212
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition PMTHitCollection.cc:124
const_iterator end() const
Definition PMTHitCollection.h:209
void setSubsetCollection(bool setSubset=true) final
Definition PMTHitCollection.cc:61
static constexpr auto dataTypeName
Definition PMTHitCollection.h:112
MutablePMTHit create()
Append a new object to the collection, and return this object.
Definition PMTHitCollection.cc:72
bool isSubsetCollection() const final
Definition PMTHitCollection.h:148
PMTHitCollection(PMTHitCollection &&)=default
Definition PMTHitCollection.h:36
bool operator!=(const PMTHitCollectionIterator &x) const
Definition PMTHitCollection.h:43
PMTHitCollectionIterator & operator++()
Definition PMTHitCollection.cc:362
bool operator==(const PMTHitCollectionIterator &x) const
Definition PMTHitCollection.h:47
PMTHitCollectionIterator(size_t index, const PMTHitObjPointerContainer *collection)
Definition PMTHitCollection.h:38
PMTHitCollectionIterator(const PMTHitCollectionIterator &)=delete
PMTHit * operator->()
Definition PMTHitCollection.cc:357
PMTHit operator*()
Definition PMTHitCollection.cc:352
PMTHitCollectionIterator & operator=(const PMTHitCollectionIterator &)=delete
Definition PMTHit.h:42
Definition PMTHitCollection.h:62
PMTHitMutableCollectionIterator(const PMTHitMutableCollectionIterator &)=delete
PMTHitMutableCollectionIterator & operator++()
Definition PMTHitCollection.cc:379
bool operator!=(const PMTHitMutableCollectionIterator &x) const
Definition PMTHitCollection.h:69
PMTHitMutableCollectionIterator(size_t index, const PMTHitObjPointerContainer *collection)
Definition PMTHitCollection.h:64
MutablePMTHit operator*()
Definition PMTHitCollection.cc:369
MutablePMTHit * operator->()
Definition PMTHitCollection.cc:374
PMTHitMutableCollectionIterator & operator=(const PMTHitMutableCollectionIterator &)=delete
bool operator==(const PMTHitMutableCollectionIterator &x) const
Definition PMTHitCollection.h:73
Definition PMTHitObj.h:17
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< PMTHitObj * > PMTHitObjPointerContainer
Definition PMTHitCollectionData.h:22
Definition CalorimeterHit.h:31