EDM4eic
EIC data model
Loading...
Searching...
No Matches
TrajectoryCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_TrajectoryCollection_H
4#define EDM4EIC_TrajectoryCollection_H
5
6// datamodel specific includes
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;
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 TrajectoryCollectionIterator(size_t index, const TrajectoryObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrajectoryObj>{nullptr}), m_collection(collection) {}
49
55
56 auto operator<=>(const TrajectoryCollectionIterator& other) const {
57 return m_index <=> other.m_index;
58 }
59
61 return m_index == x.m_index;
62 }
63
64 reference operator*() const;
77
78private:
79 size_t m_index{0};
80 Trajectory m_object { podio::utils::MaybeSharedPtr<TrajectoryObj>{nullptr} };
81 const TrajectoryObjPointerContainer* 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 TrajectoryMutableCollectionIterator(size_t index, const TrajectoryObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrajectoryObj>{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 MutableTrajectory m_object { podio::utils::MaybeSharedPtr<TrajectoryObj>{nullptr} };
130 const TrajectoryObjPointerContainer* m_collection{nullptr};
131};
132
133
134/**
135A Collection is identified by an ID.
136*/
137class TrajectoryCollection : 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 TrajectoryCollection(TrajectoryCollectionData&& data, bool isSubsetColl);
150 // This is a move-only type
155
156// TrajectoryCollection(TrajectoryVector* data, uint32_t collectionID);
157 ~TrajectoryCollection() override;
158
159 constexpr static std::string_view typeName = "edm4eic::TrajectoryCollection";
160 constexpr static std::string_view valueTypeName = "edm4eic::Trajectory";
161 constexpr static std::string_view dataTypeName = "edm4eic::TrajectoryData";
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 TrajectoryCollection* operator->() { return static_cast<TrajectoryCollection*>(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 MutableTrajectory 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 Trajectory operator[](std::size_t index) const;
205 /// Returns the object of a given index
206 MutableTrajectory operator[](std::size_t index);
207 /// Returns the const object of given index
208 Trajectory at(std::size_t index) const;
209 /// Returns the object of given index
210 MutableTrajectory at(std::size_t index);
211
212
213 /// Append object to the collection
214 void push_back(const MutableTrajectory& object);
215 /// Append an object to the (subset) collection
216 void push_back(const Trajectory& 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] (TrajectoryObj* 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::uint32_t> type(const size_t nElem = 0) const;
286 std::vector<std::uint32_t> nStates(const size_t nElem = 0) const;
287 std::vector<std::uint32_t> nMeasurements(const size_t nElem = 0) const;
288 std::vector<std::uint32_t> nOutliers(const size_t nElem = 0) const;
289 std::vector<std::uint32_t> nHoles(const size_t nElem = 0) const;
290 std::vector<std::uint32_t> nSharedHits(const size_t nElem = 0) const;
291
292private:
293 // For setReferences, we need to give our own CollectionData access to our
294 // private entries. Otherwise we would need to expose a public member function
295 // that gives access to the Obj* which is definitely not what we want
297
298 bool m_isValid{false};
299 mutable bool m_isPrepared{false};
300 bool m_isSubsetColl{false};
301 uint32_t m_collectionID{0};
302 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
303 mutable TrajectoryCollectionData m_storage{};
304};
305
306std::ostream& operator<<(std::ostream& o, const TrajectoryCollection& v);
307
308template<typename... Args>
310 if (m_isSubsetColl) {
311 throw std::logic_error("Cannot create new elements on a subset collection");
312 }
313 const int size = m_storage.entries.size();
314 auto obj = new TrajectoryObj({size, m_collectionID}, {std::forward<Args>(args)...});
315 m_storage.entries.push_back(obj);
316
317 // Need to initialize the relation vectors manually for the {ObjectID, TrajectoryData} constructor
318 obj->m_trackParameters = new std::vector<edm4eic::TrackParameters>();
319 obj->m_measurements_deprecated = new std::vector<edm4eic::Measurement2D>();
320 obj->m_outliers_deprecated = new std::vector<edm4eic::Measurement2D>();
321 obj->m_measurementChi2 = new std::vector<float>();
322 obj->m_outlierChi2 = new std::vector<float>();
323 m_storage.createRelations(obj);
324 return MutableTrajectory(podio::utils::MaybeSharedPtr(obj));
325}
326
327#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
328void to_json(nlohmann::json& j, const TrajectoryCollection& collection);
329#endif
330
331} // namespace edm4eic
332
333
334#endif
Definition MutableTrajectory.h:39
Definition TrajectoryCollectionData.h:33
Definition TrajectoryCollection.h:137
ptrdiff_t difference_type
Definition TrajectoryCollection.h:143
static constexpr std::string_view dataTypeName
Definition TrajectoryCollection.h:161
const_reverse_iterator crend() const
Definition TrajectoryCollection.h:280
const_iterator cend() const
Definition TrajectoryCollection.h:261
TrajectoryCollection & operator=(TrajectoryCollection &&)=default
TrajectoryCollection & operator=(const TrajectoryCollection &)=delete
bool isSubsetCollection() const final
Definition TrajectoryCollection.h:197
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition TrajectoryCollection.cc:230
bool isValid() const final
Definition TrajectoryCollection.h:239
const_reverse_iterator crbegin() const
Definition TrajectoryCollection.h:271
void prepareAfterRead() final
Definition TrajectoryCollection.cc:109
TrajectoryCollection(const TrajectoryCollection &)=delete
MutableTrajectory create()
Append a new object to the collection, and return this object.
Definition TrajectoryCollection.cc:83
bool empty() const final
Is the collection empty.
Definition TrajectoryCollection.cc:68
void setSubsetCollection(bool setSubset=true) final
Definition TrajectoryCollection.cc:72
const_reverse_iterator rend() const
Definition TrajectoryCollection.h:277
const_reverse_iterator rbegin() const
Definition TrajectoryCollection.h:268
const_iterator begin() const
Definition TrajectoryCollection.h:249
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition TrajectoryCollection.cc:523
std::size_t size() const final
number of elements in the collection
Definition TrajectoryCollection.cc:54
Trajectory value_type
Definition TrajectoryCollection.h:139
const_iterator end() const
Definition TrajectoryCollection.h:258
iterator end()
Definition TrajectoryCollection.h:255
uint32_t getID() const final
Definition TrajectoryCollection.h:235
reverse_iterator rbegin()
Definition TrajectoryCollection.h:265
std::size_t max_size() const final
maximal number of elements in the collection
Definition TrajectoryCollection.cc:58
TrajectoryCollection(TrajectoryCollection &&)=default
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition TrajectoryCollection.cc:124
std::reverse_iterator< iterator > reverse_iterator
Definition TrajectoryCollection.h:146
static constexpr std::string_view valueTypeName
Definition TrajectoryCollection.h:160
static constexpr std::string_view typeName
Definition TrajectoryCollection.h:159
void prepareForWrite() const final
Definition TrajectoryCollection.cc:100
iterator begin()
Definition TrajectoryCollection.h:246
TrajectoryMutableCollectionIterator iterator
Definition TrajectoryCollection.h:142
~TrajectoryCollection() override
Definition TrajectoryCollection.cc:33
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition TrajectoryCollection.h:191
reverse_iterator rend()
Definition TrajectoryCollection.h:274
const_iterator cbegin() const
Definition TrajectoryCollection.h:252
MutableTrajectory mutable_type
Definition TrajectoryCollection.h:140
const std::string_view getTypeName() const final
fully qualified type name
Definition TrajectoryCollection.h:189
TrajectoryCollection()
Definition TrajectoryCollection.cc:27
size_t size_type
Definition TrajectoryCollection.h:144
void clear() final
Definition TrajectoryCollection.cc:95
void setID(uint32_t ID) final
Definition TrajectoryCollection.h:225
Trajectory at(std::size_t index) const
Returns the const object of given index.
Definition TrajectoryCollection.cc:42
TrajectoryCollectionIterator const_iterator
Definition TrajectoryCollection.h:141
friend class TrajectoryCollectionData
Definition TrajectoryCollection.h:296
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition TrajectoryCollection.h:145
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition TrajectoryCollection.cc:161
void push_back(const MutableTrajectory &object)
Append object to the collection.
Definition TrajectoryCollection.cc:128
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition TrajectoryCollection.h:193
Definition TrajectoryCollection.h:36
TrajectoryCollectionIterator(const TrajectoryCollectionIterator &)=default
TrajectoryCollectionIterator(size_t index, const TrajectoryObjPointerContainer *collection)
Definition TrajectoryCollection.h:47
ptrdiff_t difference_type
Definition TrajectoryCollection.h:39
bool operator==(const TrajectoryCollectionIterator &x) const
Definition TrajectoryCollection.h:60
auto operator<=>(const TrajectoryCollectionIterator &other) const
Definition TrajectoryCollection.h:56
std::random_access_iterator_tag iterator_concept
Definition TrajectoryCollection.h:45
TrajectoryCollectionIterator(TrajectoryCollectionIterator &&)=default
std::input_iterator_tag iterator_category
Definition TrajectoryCollection.h:42
TrajectoryCollectionIterator & operator--()
Definition TrajectoryCollection.cc:359
TrajectoryCollectionIterator & operator-=(difference_type n)
Definition TrajectoryCollection.cc:385
TrajectoryCollectionIterator & operator++()
Definition TrajectoryCollection.cc:348
pointer operator->()
Definition TrajectoryCollection.cc:343
reference operator*() const
Definition TrajectoryCollection.cc:339
TrajectoryCollectionIterator & operator=(TrajectoryCollectionIterator &&)=default
reference operator[](difference_type n) const
Definition TrajectoryCollection.cc:396
TrajectoryCollectionIterator & operator=(const TrajectoryCollectionIterator &)=default
TrajectoryCollectionIterator & operator+=(difference_type n)
Definition TrajectoryCollection.cc:370
Trajectory value_type
Definition TrajectoryCollection.h:38
TrajectoryCollectionIterator operator-(difference_type n) const
Definition TrajectoryCollection.cc:390
Trajectory reference
Definition TrajectoryCollection.h:40
TrajectoryCollectionIterator operator+(difference_type n) const
Definition TrajectoryCollection.cc:375
Trajectory * pointer
Definition TrajectoryCollection.h:41
Definition Trajectory.h:47
Definition TrajectoryCollection.h:85
Trajectory value_type
Definition TrajectoryCollection.h:87
bool operator==(const TrajectoryMutableCollectionIterator &x) const
Definition TrajectoryCollection.h:109
TrajectoryMutableCollectionIterator & operator=(TrajectoryMutableCollectionIterator &&)=default
std::random_access_iterator_tag iterator_concept
Definition TrajectoryCollection.h:94
MutableTrajectory reference
Definition TrajectoryCollection.h:89
TrajectoryMutableCollectionIterator(TrajectoryMutableCollectionIterator &&)=default
TrajectoryMutableCollectionIterator & operator--()
Definition TrajectoryCollection.cc:426
TrajectoryMutableCollectionIterator(size_t index, const TrajectoryObjPointerContainer *collection)
Definition TrajectoryCollection.h:96
TrajectoryMutableCollectionIterator & operator+=(difference_type n)
Definition TrajectoryCollection.cc:437
std::input_iterator_tag iterator_category
Definition TrajectoryCollection.h:91
TrajectoryMutableCollectionIterator & operator=(const TrajectoryMutableCollectionIterator &)=default
pointer operator->()
Definition TrajectoryCollection.cc:410
reference operator*() const
Definition TrajectoryCollection.cc:406
TrajectoryMutableCollectionIterator operator-(difference_type n) const
Definition TrajectoryCollection.cc:457
TrajectoryMutableCollectionIterator & operator++()
Definition TrajectoryCollection.cc:415
reference operator[](difference_type n) const
Definition TrajectoryCollection.cc:463
TrajectoryMutableCollectionIterator & operator-=(difference_type n)
Definition TrajectoryCollection.cc:452
TrajectoryMutableCollectionIterator(const TrajectoryMutableCollectionIterator &)=default
ptrdiff_t difference_type
Definition TrajectoryCollection.h:88
MutableTrajectory * pointer
Definition TrajectoryCollection.h:90
auto operator<=>(const TrajectoryMutableCollectionIterator &other) const
Definition TrajectoryCollection.h:105
TrajectoryMutableCollectionIterator operator+(difference_type n) const
Definition TrajectoryCollection.cc:442
Definition TrajectoryObj.h:25
std::vector< edm4eic::TrackParameters > * m_trackParameters
Definition TrajectoryObj.h:42
Definition CalorimeterHit.cc:17
std::deque< TrajectoryObj * > TrajectoryObjPointerContainer
Definition TrajectoryCollectionData.h:25
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:31