EICd
EIC data model
TrackCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EICD_TrackCollection_H
4#define EICD_TrackCollection_H
5
6// datamodel specific includes
7#include "eicd/TrackData.h"
8#include "eicd/Track.h"
9#include "eicd/MutableTrack.h"
10#include "eicd/TrackObj.h"
12
13// podio specific includes
14#include "podio/ICollectionProvider.h"
15#include "podio/CollectionBase.h"
16#include "podio/CollectionIDTable.h"
17
18#ifdef PODIO_JSON_OUTPUT
19#include "nlohmann/json.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
31namespace eicd {
32
33
34
36public:
37 TrackCollectionIterator(size_t index, const TrackObjPointerContainer* collection) : m_index(index), m_object(nullptr), m_collection(collection) {}
38
41
42 bool operator!=(const TrackCollectionIterator& x) const {
43 return m_index != x.m_index; // TODO: may not be complete
44 }
45
49
50private:
51 size_t m_index;
52 Track m_object;
53 const TrackObjPointerContainer* m_collection;
54};
55
56
58public:
59 TrackMutableCollectionIterator(size_t index, const TrackObjPointerContainer* collection) : m_index(index), m_object(nullptr), m_collection(collection) {}
60
63
65 return m_index != x.m_index; // TODO: may not be complete
66 }
67
71
72private:
73 size_t m_index;
74 MutableTrack m_object;
75 const TrackObjPointerContainer* m_collection;
76};
77
78
79/**
80A Collection is identified by an ID.
81*/
82class TrackCollection : public podio::CollectionBase {
83public:
86
88 // This is a move-only type
93
94// TrackCollection(TrackVector* data, int collectionID);
96
97 void clear() final;
98
99 /// operator to allow pointer like calling of members a la LCIO
100 TrackCollection* operator->() { return (TrackCollection*) this; }
101
102 /// Append a new object to the collection, and return this object.
104
105 /// Append a new object to the collection, and return this object.
106 /// Initialized with the parameters given
107 template<typename... Args>
108 MutableTrack create(Args&&... args);
109
110 /// number of elements in the collection
111 size_t size() const final;
112
113 /// fully qualified type name
114 std::string getTypeName() const final { return std::string("eicd::TrackCollection"); }
115 /// fully qualified type name of elements - with namespace
116 std::string getValueTypeName() const final { return std::string("eicd::Track"); }
117 /// fully qualified type name of stored POD elements - with namespace
118 std::string getDataTypeName() const final { return std::string("eicd::TrackData"); }
119
120 bool isSubsetCollection() const final {
121 return m_isSubsetColl;
122 }
123
124 void setSubsetCollection(bool setSubset=true) final;
125
126 /// Returns the const object of given index
127 Track operator[](unsigned int index) const;
128 /// Returns the object of a given index
129 MutableTrack operator[](unsigned int index);
130 /// Returns the const object of given index
131 Track at(unsigned int index) const;
132 /// Returns the object of given index
133 MutableTrack at(unsigned int index);
134
135
136 /// Append object to the collection
137 void push_back(Track object);
138
139 void prepareForWrite() const final;
140 void prepareAfterRead() final;
141 bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
142
143 /// Get the collection buffers for this collection
144 podio::CollectionBuffers getBuffers() final;
145
146 void setID(unsigned ID) final {
147 m_collectionID = ID;
148 if (!m_isSubsetColl) {
149 std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
150 [ID] (TrackObj* obj) { obj->id = {obj->id.index, static_cast<int>(ID)}; }
151 );
152 }
153 m_isValid = true;
154 };
155
156 unsigned getID() const final {
157 return m_collectionID;
158 }
159
160 bool isValid() const final {
161 return m_isValid;
162 }
163
164 // support for the iterator protocol
166 return iterator(0, &m_storage.entries);
167 }
169 return const_iterator(0, &m_storage.entries);
170 }
172 return iterator(m_storage.entries.size(), &m_storage.entries);
173 }
175 return const_iterator(m_storage.entries.size(), &m_storage.entries);
176 }
177
178 template<size_t arraysize>
179 const std::array<std::int32_t, arraysize> type() const;
180 template<size_t arraysize>
181 const std::array<float, arraysize> chi2() const;
182 template<size_t arraysize>
183 const std::array<std::int32_t, arraysize> ndf() const;
184 template<size_t arraysize>
185 const std::array<edm4hep::Vector3f, arraysize> momentum() const;
186 template<size_t arraysize>
187 const std::array<eicd::Cov3f, arraysize> momentumError() const;
188 template<size_t arraysize>
189 const std::array<float, arraysize> time() const;
190 template<size_t arraysize>
191 const std::array<float, arraysize> timeError() const;
192 template<size_t arraysize>
193 const std::array<float, arraysize> charge() const;
194
195private:
196 // For setReferences, we need to give our own CollectionData access to our
197 // private entries. Otherwise we would need to expose a public member function
198 // that gives access to the Obj* which is definitely not what we want
200
201 bool m_isValid{false};
202 mutable bool m_isPrepared{false};
203 bool m_isSubsetColl{false};
204 int m_collectionID{0};
205 mutable std::unique_ptr<std::mutex> m_storageMtx{std::make_unique<std::mutex>()};
206 mutable TrackCollectionData m_storage{};
207};
208
209std::ostream& operator<<(std::ostream& o, const TrackCollection& v);
210
211template<typename... Args>
212MutableTrack TrackCollection::create(Args&&... args) {
213 if (m_isSubsetColl) {
214 throw std::logic_error("Cannot create new elements on a subset collection");
215 }
216 const int size = m_storage.entries.size();
217 auto obj = new TrackObj({size, m_collectionID}, {std::forward<Args>(args)...});
218 m_storage.entries.push_back(obj);
219
220 // Need to initialize the relation vectors manually for the {ObjectID, TrackData} constructor
221 obj->m_parameters = new std::vector<eicd::TrackParameters>();
222 obj->m_trackerHits = new std::vector<eicd::TrackerHit>();
223 obj->m_tracks = new std::vector<eicd::Track>();
224 m_storage.createRelations(obj);
225 return MutableTrack(obj);
226}
227
228template<size_t arraysize>
229const std::array<std::int32_t, arraysize> TrackCollection::type() const {
230 std::array<std::int32_t, arraysize> tmp{};
231 const auto valid_size = std::min(arraysize, m_storage.entries.size());
232 for (unsigned i = 0; i < valid_size; ++i) {
233 tmp[i] = m_storage.entries[i]->data.type;
234 }
235 return tmp;
236}
237
238template<size_t arraysize>
239const std::array<float, arraysize> TrackCollection::chi2() const {
240 std::array<float, arraysize> tmp{};
241 const auto valid_size = std::min(arraysize, m_storage.entries.size());
242 for (unsigned i = 0; i < valid_size; ++i) {
243 tmp[i] = m_storage.entries[i]->data.chi2;
244 }
245 return tmp;
246}
247
248template<size_t arraysize>
249const std::array<std::int32_t, arraysize> TrackCollection::ndf() const {
250 std::array<std::int32_t, arraysize> tmp{};
251 const auto valid_size = std::min(arraysize, m_storage.entries.size());
252 for (unsigned i = 0; i < valid_size; ++i) {
253 tmp[i] = m_storage.entries[i]->data.ndf;
254 }
255 return tmp;
256}
257
258template<size_t arraysize>
259const std::array<edm4hep::Vector3f, arraysize> TrackCollection::momentum() const {
260 std::array<edm4hep::Vector3f, arraysize> tmp{};
261 const auto valid_size = std::min(arraysize, m_storage.entries.size());
262 for (unsigned i = 0; i < valid_size; ++i) {
263 tmp[i] = m_storage.entries[i]->data.momentum;
264 }
265 return tmp;
266}
267
268template<size_t arraysize>
269const std::array<eicd::Cov3f, arraysize> TrackCollection::momentumError() const {
270 std::array<eicd::Cov3f, arraysize> tmp{};
271 const auto valid_size = std::min(arraysize, m_storage.entries.size());
272 for (unsigned i = 0; i < valid_size; ++i) {
273 tmp[i] = m_storage.entries[i]->data.momentumError;
274 }
275 return tmp;
276}
277
278template<size_t arraysize>
279const std::array<float, arraysize> TrackCollection::time() const {
280 std::array<float, arraysize> tmp{};
281 const auto valid_size = std::min(arraysize, m_storage.entries.size());
282 for (unsigned i = 0; i < valid_size; ++i) {
283 tmp[i] = m_storage.entries[i]->data.time;
284 }
285 return tmp;
286}
287
288template<size_t arraysize>
289const std::array<float, arraysize> TrackCollection::timeError() const {
290 std::array<float, arraysize> tmp{};
291 const auto valid_size = std::min(arraysize, m_storage.entries.size());
292 for (unsigned i = 0; i < valid_size; ++i) {
293 tmp[i] = m_storage.entries[i]->data.timeError;
294 }
295 return tmp;
296}
297
298template<size_t arraysize>
299const std::array<float, arraysize> TrackCollection::charge() const {
300 std::array<float, arraysize> tmp{};
301 const auto valid_size = std::min(arraysize, m_storage.entries.size());
302 for (unsigned i = 0; i < valid_size; ++i) {
303 tmp[i] = m_storage.entries[i]->data.charge;
304 }
305 return tmp;
306}
307
308
309#ifdef PODIO_JSON_OUTPUT
310void to_json(nlohmann::json& j, const TrackCollection& collection);
311#endif
312
313} // namespace eicd
314
315
316#endif
Definition: MutableTrack.h:33
Definition: TrackCollectionData.h:30
TrackObjPointerContainer entries
Definition: TrackCollectionData.h:35
Definition: TrackCollection.h:82
MutableTrack create()
Append a new object to the collection, and return this object.
Definition: TrackCollection.cc:54
TrackCollection & operator=(TrackCollection &&)=default
TrackCollection(const TrackCollection &)=delete
std::string getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition: TrackCollection.h:118
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition: TrackCollection.cc:107
void prepareAfterRead() final
Definition: TrackCollection.cc:92
podio::CollectionBuffers getBuffers() final
Get the collection buffers for this collection.
Definition: TrackCollection.cc:137
void setSubsetCollection(bool setSubset=true) final
Definition: TrackCollection.cc:43
unsigned getID() const final
Definition: TrackCollection.h:156
size_t size() const final
number of elements in the collection
Definition: TrackCollection.cc:39
bool isSubsetCollection() const final
Definition: TrackCollection.h:120
TrackCollection & operator=(const TrackCollection &)=delete
std::string getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition: TrackCollection.h:116
TrackCollection(TrackCollection &&)=default
const_iterator begin() const
Definition: TrackCollection.h:168
const_iterator end() const
Definition: TrackCollection.h:174
Track at(unsigned int index) const
Returns the const object of given index.
Definition: TrackCollection.cc:27
iterator end()
Definition: TrackCollection.h:171
void setID(unsigned ID) final
Definition: TrackCollection.h:146
std::string getTypeName() const final
fully qualified type name
Definition: TrackCollection.h:114
~TrackCollection()
Definition: TrackCollection.cc:18
TrackCollection()
Definition: TrackCollection.cc:15
bool isValid() const final
Definition: TrackCollection.h:160
void push_back(Track object)
Append object to the collection.
Definition: TrackCollection.cc:111
void clear() final
Definition: TrackCollection.cc:66
iterator begin()
Definition: TrackCollection.h:165
void prepareForWrite() const final
Definition: TrackCollection.cc:71
Definition: TrackCollection.h:35
TrackCollectionIterator(size_t index, const TrackObjPointerContainer *collection)
Definition: TrackCollection.h:37
TrackCollectionIterator & operator++()
Definition: TrackCollection.cc:161
Track operator*()
Definition: TrackCollection.cc:151
Track * operator->()
Definition: TrackCollection.cc:156
TrackCollectionIterator & operator=(const TrackCollectionIterator &)=delete
TrackCollectionIterator(const TrackCollectionIterator &)=delete
bool operator!=(const TrackCollectionIterator &x) const
Definition: TrackCollection.h:42
Definition: Track.h:32
Definition: TrackCollection.h:57
bool operator!=(const TrackMutableCollectionIterator &x) const
Definition: TrackCollection.h:64
TrackMutableCollectionIterator & operator=(const TrackMutableCollectionIterator &)=delete
MutableTrack operator*()
Definition: TrackCollection.cc:168
MutableTrack * operator->()
Definition: TrackCollection.cc:173
TrackMutableCollectionIterator & operator++()
Definition: TrackCollection.cc:178
TrackMutableCollectionIterator(const TrackMutableCollectionIterator &)=delete
TrackMutableCollectionIterator(size_t index, const TrackObjPointerContainer *collection)
Definition: TrackCollection.h:59
Definition: TrackObj.h:20
std::vector< eicd::TrackParameters > * m_parameters
Definition: TrackObj.h:35
Definition: CalorimeterHit.cc:13
std::deque< TrackObj * > TrackObjPointerContainer
Definition: TrackCollectionData.h:22
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition: CalorimeterHit.cc:93