EDM4eic
EIC data model
Loading...
Searching...
No Matches
TrackCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_TrackCollection_H
4#define EDM4EIC_TrackCollection_H
5
6// datamodel specific includes
7#include "edm4eic/Track.h"
9#include "edm4eic/TrackObj.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:
39 using difference_type = ptrdiff_t;
41 using pointer = Track*;
42 using iterator_category = std::input_iterator_tag;
43 // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
44 // remain valid as long as the iterator is valid, not as long as the range is valid.
45 using iterator_concept = std::random_access_iterator_tag;
46
47 TrackCollectionIterator(size_t index, const TrackObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackObj>{nullptr}), m_collection(collection) {}
49
55
56 auto operator<=>(const TrackCollectionIterator& other) const {
57 return m_index <=> other.m_index;
58 }
59
60 bool operator==(const TrackCollectionIterator& x) const {
61 return m_index == x.m_index;
62 }
63
64 reference operator*() const;
77
78private:
79 size_t m_index{0};
80 Track m_object { podio::utils::MaybeSharedPtr<TrackObj>{nullptr} };
81 const TrackObjPointerContainer* m_collection{nullptr};
82};
83
84
86public:
88 using difference_type = ptrdiff_t;
91 using iterator_category = std::input_iterator_tag;
92 // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
93 // remain valid as long as the iterator is valid, not as long as the range is valid.
94 using iterator_concept = std::random_access_iterator_tag;
95
96 TrackMutableCollectionIterator(size_t index, const TrackObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackObj>{nullptr}), m_collection(collection) {}
98
104
106 return m_index <=> other.m_index;
107 }
108
110 return m_index == x.m_index;
111 }
112
113 reference operator*() const;
126
127private:
128 size_t m_index{0};
129 MutableTrack m_object { podio::utils::MaybeSharedPtr<TrackObj>{nullptr} };
130 const TrackObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class TrackCollection : public podio::CollectionBase {
138public:
143 using difference_type = ptrdiff_t;
144 using size_type = size_t;
145 using const_reverse_iterator = std::reverse_iterator<const_iterator>;
146 using reverse_iterator = std::reverse_iterator<iterator>;
147
149 TrackCollection(TrackCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// TrackCollection(TrackVector* data, uint32_t collectionID);
157 ~TrackCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::TrackCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::Track";
161 constexpr static std::string_view dataTypeName = "edm4eic::TrackData";
162
163 void clear() final;
164
165 /// Print this collection to the passed stream
166 void print(std::ostream& os=std::cout, bool flush=true) const final;
167
168 /// operator to allow pointer like calling of members a la LCIO
169 TrackCollection* operator->() { return static_cast<TrackCollection*>(this); }
170
171 /// Append a new object to the collection, and return this object.
173
174 /// Append a new object to the collection, and return this object.
175 /// Initialized with the parameters given
176 template<typename... Args>
177 MutableTrack create(Args&&... args);
178
179 /// number of elements in the collection
180 std::size_t size() const final;
181
182 /// maximal number of elements in the collection
183 std::size_t max_size() const final;
184
185 /// Is the collection empty
186 bool empty() const final;
187
188 /// fully qualified type name
189 const std::string_view getTypeName() const final { return typeName; }
190 /// fully qualified type name of elements - with namespace
191 const std::string_view getValueTypeName() const final { return valueTypeName; }
192 /// fully qualified type name of stored POD elements - with namespace
193 const std::string_view getDataTypeName() const final { return dataTypeName; }
194 /// schema version
195 podio::SchemaVersionT getSchemaVersion() const final;
196
197 bool isSubsetCollection() const final {
198 return m_isSubsetColl;
199 }
200
201 void setSubsetCollection(bool setSubset=true) final;
202
203 /// Returns the const object of given index
204 Track operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableTrack operator[](std::size_t index);
207 /// Returns the const object of given index
208 Track at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableTrack at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableTrack& object);
215 /// Append an object to the (subset) collection
216 void push_back(const Track& object);
217
218 void prepareForWrite() const final;
219 void prepareAfterRead() final;
220 bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
221
222 /// Get the collection buffers for this collection
223 podio::CollectionWriteBuffers getBuffers() final;
224
225 void setID(uint32_t ID) final {
226 m_collectionID = ID;
227 if (!m_isSubsetColl) {
228 std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
229 [ID] (TrackObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
230 );
231 }
232 m_isValid = true;
233 }
234
235 uint32_t getID() const final {
236 return m_collectionID;
237 }
238
239 bool isValid() const final {
240 return m_isValid;
241 }
242
243 size_t getDatamodelRegistryIndex() const final;
244
245 // support for the iterator protocol
247 return iterator(0, &m_storage.entries);
248 }
250 return const_iterator(0, &m_storage.entries);
251 }
253 return begin();
254 }
256 return iterator(m_storage.entries.size(), &m_storage.entries);
257 }
259 return const_iterator(m_storage.entries.size(), &m_storage.entries);
260 }
262 return end();
263 }
264 // reverse iterators
266 return reverse_iterator(end());
267 }
272 return rbegin();
273 }
275 return reverse_iterator(begin());
276 }
281 return rend();
282 }
283
284
285 std::vector<std::int32_t> type(const size_t nElem = 0) const;
286 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
287 std::vector<edm4hep::Vector3f> momentum(const size_t nElem = 0) const;
288 std::vector<edm4eic::Cov6f> positionMomentumCovariance(const size_t nElem = 0) const;
289 std::vector<float> time(const size_t nElem = 0) const;
290 std::vector<float> timeError(const size_t nElem = 0) const;
291 std::vector<float> charge(const size_t nElem = 0) const;
292 std::vector<float> chi2(const size_t nElem = 0) const;
293 std::vector<std::uint32_t> ndf(const size_t nElem = 0) const;
294 std::vector<std::int32_t> pdg(const size_t nElem = 0) const;
295
296private:
297 // For setReferences, we need to give our own CollectionData access to our
298 // private entries. Otherwise we would need to expose a public member function
299 // that gives access to the Obj* which is definitely not what we want
301
302 bool m_isValid{false};
303 mutable bool m_isPrepared{false};
304 bool m_isSubsetColl{false};
305 uint32_t m_collectionID{0};
306 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
307 mutable TrackCollectionData m_storage{};
308};
309
310std::ostream& operator<<(std::ostream& o, const TrackCollection& v);
311
312template<typename... Args>
314 if (m_isSubsetColl) {
315 throw std::logic_error("Cannot create new elements on a subset collection");
316 }
317 const int size = m_storage.entries.size();
318 auto obj = new TrackObj({size, m_collectionID}, {std::forward<Args>(args)...});
319 m_storage.entries.push_back(obj);
320
321 // Need to initialize the relation vectors manually for the {ObjectID, TrackData} constructor
322 obj->m_measurements = new std::vector<edm4eic::Measurement2D>();
323 obj->m_tracks = new std::vector<edm4eic::Track>();
324 m_storage.createRelations(obj);
325 return MutableTrack(podio::utils::MaybeSharedPtr(obj));
326}
327
328#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
329void to_json(nlohmann::json& j, const TrackCollection& collection);
330#endif
331
332} // namespace edm4eic
333
334
335#endif
Definition MutableTrack.h:40
Definition TrackCollectionData.h:32
Definition TrackCollection.h:137
reverse_iterator rbegin()
Definition TrackCollection.h:265
size_t size_type
Definition TrackCollection.h:144
reverse_iterator rend()
Definition TrackCollection.h:274
static constexpr std::string_view valueTypeName
Definition TrackCollection.h:160
TrackCollectionIterator const_iterator
Definition TrackCollection.h:141
iterator begin()
Definition TrackCollection.h:246
~TrackCollection() override
Definition TrackCollection.cc:31
uint32_t getID() const final
Definition TrackCollection.h:235
const std::string_view getTypeName() const final
fully qualified type name
Definition TrackCollection.h:189
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition TrackCollection.cc:159
TrackCollection & operator=(TrackCollection &&)=default
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition TrackCollection.h:193
friend class TrackCollectionData
Definition TrackCollection.h:300
void setSubsetCollection(bool setSubset=true) final
Definition TrackCollection.cc:70
const_iterator cbegin() const
Definition TrackCollection.h:252
bool empty() const final
Is the collection empty.
Definition TrackCollection.cc:66
const_reverse_iterator rend() const
Definition TrackCollection.h:277
TrackMutableCollectionIterator iterator
Definition TrackCollection.h:142
iterator end()
Definition TrackCollection.h:255
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition TrackCollection.h:191
static constexpr std::string_view typeName
Definition TrackCollection.h:159
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition TrackCollection.cc:122
Track at(std::size_t index) const
Returns the const object of given index.
Definition TrackCollection.cc:40
void prepareAfterRead() final
Definition TrackCollection.cc:107
const_iterator begin() const
Definition TrackCollection.h:249
const_reverse_iterator crend() const
Definition TrackCollection.h:280
ptrdiff_t difference_type
Definition TrackCollection.h:143
TrackCollection(const TrackCollection &)=delete
void prepareForWrite() const final
Definition TrackCollection.cc:98
void clear() final
Definition TrackCollection.cc:93
void setID(uint32_t ID) final
Definition TrackCollection.h:225
MutableTrack mutable_type
Definition TrackCollection.h:140
const_reverse_iterator crbegin() const
Definition TrackCollection.h:271
TrackCollection()
Definition TrackCollection.cc:25
static constexpr std::string_view dataTypeName
Definition TrackCollection.h:161
MutableTrack create()
Append a new object to the collection, and return this object.
Definition TrackCollection.cc:81
bool isSubsetCollection() const final
Definition TrackCollection.h:197
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition TrackCollection.cc:268
const_reverse_iterator rbegin() const
Definition TrackCollection.h:268
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition TrackCollection.cc:544
std::size_t size() const final
number of elements in the collection
Definition TrackCollection.cc:52
TrackCollection(TrackCollection &&)=default
std::size_t max_size() const final
maximal number of elements in the collection
Definition TrackCollection.cc:56
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition TrackCollection.h:145
Track value_type
Definition TrackCollection.h:139
void push_back(const MutableTrack &object)
Append object to the collection.
Definition TrackCollection.cc:126
bool isValid() const final
Definition TrackCollection.h:239
const_iterator cend() const
Definition TrackCollection.h:261
TrackCollection & operator=(const TrackCollection &)=delete
std::reverse_iterator< iterator > reverse_iterator
Definition TrackCollection.h:146
const_iterator end() const
Definition TrackCollection.h:258
Definition TrackCollection.h:36
pointer operator->()
Definition TrackCollection.cc:375
TrackCollectionIterator(TrackCollectionIterator &&)=default
std::random_access_iterator_tag iterator_concept
Definition TrackCollection.h:45
bool operator==(const TrackCollectionIterator &x) const
Definition TrackCollection.h:60
TrackCollectionIterator & operator-=(difference_type n)
Definition TrackCollection.cc:417
TrackCollectionIterator & operator++()
Definition TrackCollection.cc:380
TrackCollectionIterator & operator+=(difference_type n)
Definition TrackCollection.cc:402
TrackCollectionIterator & operator=(const TrackCollectionIterator &)=default
reference operator[](difference_type n) const
Definition TrackCollection.cc:428
TrackCollectionIterator & operator--()
Definition TrackCollection.cc:391
Track reference
Definition TrackCollection.h:40
TrackCollectionIterator(const TrackCollectionIterator &)=default
ptrdiff_t difference_type
Definition TrackCollection.h:39
reference operator*() const
Definition TrackCollection.cc:371
TrackCollectionIterator(size_t index, const TrackObjPointerContainer *collection)
Definition TrackCollection.h:47
auto operator<=>(const TrackCollectionIterator &other) const
Definition TrackCollection.h:56
TrackCollectionIterator operator-(difference_type n) const
Definition TrackCollection.cc:422
Track value_type
Definition TrackCollection.h:38
TrackCollectionIterator operator+(difference_type n) const
Definition TrackCollection.cc:407
std::input_iterator_tag iterator_category
Definition TrackCollection.h:42
TrackCollectionIterator & operator=(TrackCollectionIterator &&)=default
Track * pointer
Definition TrackCollection.h:41
Definition Track.h:48
Definition TrackCollection.h:85
MutableTrack * pointer
Definition TrackCollection.h:90
TrackMutableCollectionIterator(size_t index, const TrackObjPointerContainer *collection)
Definition TrackCollection.h:96
auto operator<=>(const TrackMutableCollectionIterator &other) const
Definition TrackCollection.h:105
std::random_access_iterator_tag iterator_concept
Definition TrackCollection.h:94
TrackMutableCollectionIterator(TrackMutableCollectionIterator &&)=default
MutableTrack reference
Definition TrackCollection.h:89
TrackMutableCollectionIterator operator+(difference_type n) const
Definition TrackCollection.cc:474
TrackMutableCollectionIterator(const TrackMutableCollectionIterator &)=default
TrackMutableCollectionIterator & operator--()
Definition TrackCollection.cc:458
reference operator*() const
Definition TrackCollection.cc:438
TrackMutableCollectionIterator & operator=(const TrackMutableCollectionIterator &)=default
pointer operator->()
Definition TrackCollection.cc:442
bool operator==(const TrackMutableCollectionIterator &x) const
Definition TrackCollection.h:109
std::input_iterator_tag iterator_category
Definition TrackCollection.h:91
TrackMutableCollectionIterator & operator++()
Definition TrackCollection.cc:447
TrackMutableCollectionIterator & operator=(TrackMutableCollectionIterator &&)=default
reference operator[](difference_type n) const
Definition TrackCollection.cc:495
TrackMutableCollectionIterator & operator-=(difference_type n)
Definition TrackCollection.cc:484
ptrdiff_t difference_type
Definition TrackCollection.h:88
Track value_type
Definition TrackCollection.h:87
TrackMutableCollectionIterator & operator+=(difference_type n)
Definition TrackCollection.cc:469
TrackMutableCollectionIterator operator-(difference_type n) const
Definition TrackCollection.cc:489
Definition TrackObj.h:24
std::vector< edm4eic::Measurement2D > * m_measurements
Definition TrackObj.h:41
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< TrackObj * > TrackObjPointerContainer
Definition TrackCollectionData.h:24
Definition CalorimeterHit.h:31