EDM4eic
EIC data model
Loading...
Searching...
No Matches
TrackerHitCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_TrackerHitCollection_H
4#define EDM4EIC_TrackerHitCollection_H
5
6// datamodel specific includes
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 TrackerHitCollectionIterator(size_t index, const TrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackerHitObj>{nullptr}), m_collection(collection) {}
43
46
48 return m_index != x.m_index; // TODO: may not be complete
49 }
50
52 return m_index == x.m_index; // TODO: may not be complete
53 }
54
58
59private:
60 size_t m_index;
61 TrackerHit m_object;
62 const TrackerHitObjPointerContainer* m_collection;
63};
64
65
67public:
68 TrackerHitMutableCollectionIterator(size_t index, const TrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackerHitObj>{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 MutableTrackerHit m_object;
88 const TrackerHitObjPointerContainer* m_collection;
89};
90
91
92/**
93A Collection is identified by an ID.
94*/
95class TrackerHitCollection : public podio::CollectionBase {
96public:
100
102 TrackerHitCollection(TrackerHitCollectionData&& data, bool isSubsetColl);
103 // This is a move-only type
108
109// TrackerHitCollection(TrackerHitVector* data, uint32_t collectionID);
111
112 constexpr static auto typeName = "edm4eic::TrackerHitCollection";
113 constexpr static auto valueTypeName = "edm4eic::TrackerHit";
114 constexpr static auto dataTypeName = "edm4eic::TrackerHitData";
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 TrackerHitCollection* operator->() { return (TrackerHitCollection*) 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 MutableTrackerHit 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 TrackerHit operator[](std::size_t index) const;
155 /// Returns the object of a given index
156 MutableTrackerHit operator[](std::size_t index);
157 /// Returns the const object of given index
158 TrackerHit at(std::size_t index) const;
159 /// Returns the object of given index
160 MutableTrackerHit at(std::size_t index);
161
162
163 /// Append object to the collection
164 void push_back(MutableTrackerHit object);
165 /// Append an object to the (subset) collection
166 void push_back(TrackerHit 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] (TrackerHitObj* 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<edm4hep::Vector3f> position(const size_t nElem = 0) const;
211 std::vector<edm4eic::CovDiag3f> positionError(const size_t nElem = 0) const;
212 std::vector<float> time(const size_t nElem = 0) const;
213 std::vector<float> timeError(const size_t nElem = 0) const;
214 std::vector<float> edep(const size_t nElem = 0) const;
215 std::vector<float> edepError(const size_t nElem = 0) const;
216
217private:
218 // For setReferences, we need to give our own CollectionData access to our
219 // private entries. Otherwise we would need to expose a public member function
220 // that gives access to the Obj* which is definitely not what we want
222
223 bool m_isValid{false};
224 mutable bool m_isPrepared{false};
225 bool m_isSubsetColl{false};
226 uint32_t m_collectionID{0};
227 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
228 mutable TrackerHitCollectionData m_storage{};
229};
230
231std::ostream& operator<<(std::ostream& o, const TrackerHitCollection& v);
232
233template<typename... Args>
234MutableTrackerHit TrackerHitCollection::create(Args&&... args) {
235 if (m_isSubsetColl) {
236 throw std::logic_error("Cannot create new elements on a subset collection");
237 }
238 const int size = m_storage.entries.size();
239 auto obj = new TrackerHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
240 m_storage.entries.push_back(obj);
241
242 return MutableTrackerHit(podio::utils::MaybeSharedPtr(obj));
243}
244
245#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
246void to_json(nlohmann::json& j, const TrackerHitCollection& collection);
247#endif
248
249} // namespace edm4eic
250
251
252#endif
Definition MutableTrackerHit.h:37
Definition TrackerHitCollectionData.h:31
TrackerHitObjPointerContainer entries
Definition TrackerHitCollectionData.h:36
Definition TrackerHitCollection.h:95
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition TrackerHitCollection.h:141
TrackerHitCollection()
Definition TrackerHitCollection.cc:23
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition TrackerHitCollection.cc:394
bool empty() const final
Is the collection empty.
Definition TrackerHitCollection.cc:54
const_iterator end() const
Definition TrackerHitCollection.h:205
TrackerHit at(std::size_t index) const
Returns the const object of given index.
Definition TrackerHitCollection.cc:38
const_iterator begin() const
Definition TrackerHitCollection.h:199
void prepareAfterRead() final
Definition TrackerHitCollection.cc:106
TrackerHitCollection & operator=(const TrackerHitCollection &)=delete
bool isSubsetCollection() const final
Definition TrackerHitCollection.h:147
std::size_t size() const final
number of elements in the collection
Definition TrackerHitCollection.cc:50
void push_back(MutableTrackerHit object)
Append object to the collection.
Definition TrackerHitCollection.cc:125
const std::string_view getTypeName() const final
fully qualified type name
Definition TrackerHitCollection.h:139
MutableTrackerHit create()
Append a new object to the collection, and return this object.
Definition TrackerHitCollection.cc:69
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition TrackerHitCollection.cc:157
static constexpr auto dataTypeName
Definition TrackerHitCollection.h:114
static constexpr auto valueTypeName
Definition TrackerHitCollection.h:113
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition TrackerHitCollection.cc:236
uint32_t getID() const final
Definition TrackerHitCollection.h:185
TrackerHitCollection(const TrackerHitCollection &)=delete
void setSubsetCollection(bool setSubset=true) final
Definition TrackerHitCollection.cc:58
~TrackerHitCollection()
Definition TrackerHitCollection.cc:29
TrackerHitCollection & operator=(TrackerHitCollection &&)=default
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition TrackerHitCollection.cc:121
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition TrackerHitCollection.h:143
bool isValid() const final
Definition TrackerHitCollection.h:189
static constexpr auto typeName
Definition TrackerHitCollection.h:112
iterator end()
Definition TrackerHitCollection.h:202
TrackerHitCollection(TrackerHitCollection &&)=default
void clear() final
Definition TrackerHitCollection.cc:80
void prepareForWrite() const final
Definition TrackerHitCollection.cc:85
void setID(uint32_t ID) final
Definition TrackerHitCollection.h:175
Definition TrackerHitCollection.h:40
bool operator==(const TrackerHitCollectionIterator &x) const
Definition TrackerHitCollection.h:51
TrackerHitCollectionIterator & operator++()
Definition TrackerHitCollection.cc:344
TrackerHitCollectionIterator(size_t index, const TrackerHitObjPointerContainer *collection)
Definition TrackerHitCollection.h:42
bool operator!=(const TrackerHitCollectionIterator &x) const
Definition TrackerHitCollection.h:47
TrackerHit operator*()
Definition TrackerHitCollection.cc:334
TrackerHitCollectionIterator(const TrackerHitCollectionIterator &)=delete
TrackerHitCollectionIterator & operator=(const TrackerHitCollectionIterator &)=delete
TrackerHit * operator->()
Definition TrackerHitCollection.cc:339
Definition TrackerHit.h:38
Definition TrackerHitCollection.h:66
bool operator==(const TrackerHitMutableCollectionIterator &x) const
Definition TrackerHitCollection.h:77
TrackerHitMutableCollectionIterator & operator++()
Definition TrackerHitCollection.cc:361
TrackerHitMutableCollectionIterator & operator=(const TrackerHitMutableCollectionIterator &)=delete
TrackerHitMutableCollectionIterator(size_t index, const TrackerHitObjPointerContainer *collection)
Definition TrackerHitCollection.h:68
TrackerHitMutableCollectionIterator(const TrackerHitMutableCollectionIterator &)=delete
MutableTrackerHit * operator->()
Definition TrackerHitCollection.cc:356
bool operator!=(const TrackerHitMutableCollectionIterator &x) const
Definition TrackerHitCollection.h:73
MutableTrackerHit operator*()
Definition TrackerHitCollection.cc:351
Definition TrackerHitObj.h:21
Definition CalorimeterHit.cc:18
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:97
std::deque< TrackerHitObj * > TrackerHitObjPointerContainer
Definition TrackerHitCollectionData.h:23
Definition CalorimeterHitCollection.h:32