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:
38 TrackCollectionIterator(size_t index, const TrackObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackObj>{nullptr}), m_collection(collection) {}
39
42
43 bool operator!=(const TrackCollectionIterator& x) const {
44 return m_index != x.m_index; // TODO: may not be complete
45 }
46
47 bool operator==(const TrackCollectionIterator& x) const {
48 return m_index == x.m_index; // TODO: may not be complete
49 }
50
54
55private:
56 size_t m_index;
57 Track m_object;
58 const TrackObjPointerContainer* m_collection;
59};
60
61
63public:
64 TrackMutableCollectionIterator(size_t index, const TrackObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TrackObj>{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 MutableTrack m_object;
84 const TrackObjPointerContainer* m_collection;
85};
86
87
88/**
89A Collection is identified by an ID.
90*/
91class TrackCollection : public podio::CollectionBase {
92public:
96 using difference_type = ptrdiff_t;
97 using size_type = size_t;
98
100 TrackCollection(TrackCollectionData&& data, bool isSubsetColl);
101 // This is a move-only type
106
107// TrackCollection(TrackVector* data, uint32_t collectionID);
108 ~TrackCollection() override;
109
110 constexpr static auto typeName = "edm4eic::TrackCollection";
111 constexpr static auto valueTypeName = "edm4eic::Track";
112 constexpr static auto dataTypeName = "edm4eic::TrackData";
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 TrackCollection* operator->() { return static_cast<TrackCollection*>(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 MutableTrack 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 Track operator[](std::size_t index) const;
156 /// Returns the object of a given index
157 MutableTrack operator[](std::size_t index);
158 /// Returns the const object of given index
159 Track at(std::size_t index) const;
160 /// Returns the object of given index
161 MutableTrack at(std::size_t index);
162
163
164 /// Append object to the collection
165 void push_back(const MutableTrack& object);
166 /// Append an object to the (subset) collection
167 void push_back(const Track& 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] (TrackObj* 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::int32_t> type(const size_t nElem = 0) const;
217 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
218 std::vector<edm4hep::Vector3f> momentum(const size_t nElem = 0) const;
219 std::vector<edm4eic::Cov6f> positionMomentumCovariance(const size_t nElem = 0) const;
220 std::vector<float> time(const size_t nElem = 0) const;
221 std::vector<float> timeError(const size_t nElem = 0) const;
222 std::vector<float> charge(const size_t nElem = 0) const;
223 std::vector<float> chi2(const size_t nElem = 0) const;
224 std::vector<std::uint32_t> ndf(const size_t nElem = 0) const;
225 std::vector<std::int32_t> pdg(const size_t nElem = 0) const;
226
227private:
228 // For setReferences, we need to give our own CollectionData access to our
229 // private entries. Otherwise we would need to expose a public member function
230 // that gives access to the Obj* which is definitely not what we want
232
233 bool m_isValid{false};
234 mutable bool m_isPrepared{false};
235 bool m_isSubsetColl{false};
236 uint32_t m_collectionID{0};
237 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
238 mutable TrackCollectionData m_storage{};
239};
240
241std::ostream& operator<<(std::ostream& o, const TrackCollection& v);
242
243template<typename... Args>
244MutableTrack TrackCollection::create(Args&&... args) {
245 if (m_isSubsetColl) {
246 throw std::logic_error("Cannot create new elements on a subset collection");
247 }
248 const int size = m_storage.entries.size();
249 auto obj = new TrackObj({size, m_collectionID}, {std::forward<Args>(args)...});
250 m_storage.entries.push_back(obj);
251
252 // Need to initialize the relation vectors manually for the {ObjectID, TrackData} constructor
253 obj->m_measurements = new std::vector<edm4eic::Measurement2D>();
254 obj->m_tracks = new std::vector<edm4eic::Track>();
255 m_storage.createRelations(obj);
256 return MutableTrack(podio::utils::MaybeSharedPtr(obj));
257}
258
259#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
260void to_json(nlohmann::json& j, const TrackCollection& collection);
261#endif
262
263} // namespace edm4eic
264
265
266#endif
Definition MutableTrack.h:40
Definition TrackCollectionData.h:32
TrackObjPointerContainer entries
Definition TrackCollectionData.h:37
Definition TrackCollection.h:91
size_t size_type
Definition TrackCollection.h:97
~TrackCollection() override
Definition TrackCollection.cc:30
uint32_t getID() const final
Definition TrackCollection.h:186
const std::string_view getTypeName() const final
fully qualified type name
Definition TrackCollection.h:140
static constexpr auto dataTypeName
Definition TrackCollection.h:112
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition TrackCollection.cc:164
TrackCollection & operator=(TrackCollection &&)=default
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition TrackCollection.h:144
void setSubsetCollection(bool setSubset=true) final
Definition TrackCollection.cc:63
const_iterator cbegin() const
Definition TrackCollection.h:203
bool empty() const final
Is the collection empty.
Definition TrackCollection.cc:59
iterator end()
Definition TrackCollection.h:206
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition TrackCollection.h:142
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition TrackCollection.cc:127
static constexpr auto typeName
Definition TrackCollection.h:110
Track at(std::size_t index) const
Returns the const object of given index.
Definition TrackCollection.cc:39
void prepareAfterRead() final
Definition TrackCollection.cc:112
const_iterator begin() const
Definition TrackCollection.h:200
ptrdiff_t difference_type
Definition TrackCollection.h:96
TrackCollection(const TrackCollection &)=delete
void prepareForWrite() const final
Definition TrackCollection.cc:91
void clear() final
Definition TrackCollection.cc:86
void setID(uint32_t ID) final
Definition TrackCollection.h:176
TrackCollection()
Definition TrackCollection.cc:24
MutableTrack create()
Append a new object to the collection, and return this object.
Definition TrackCollection.cc:74
bool isSubsetCollection() const final
Definition TrackCollection.h:148
static constexpr auto valueTypeName
Definition TrackCollection.h:111
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition TrackCollection.cc:273
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition TrackCollection.cc:449
std::size_t size() const final
number of elements in the collection
Definition TrackCollection.cc:51
TrackCollection(TrackCollection &&)=default
std::size_t max_size() const final
maximal number of elements in the collection
Definition TrackCollection.cc:55
void push_back(const MutableTrack &object)
Append object to the collection.
Definition TrackCollection.cc:131
bool isValid() const final
Definition TrackCollection.h:190
const_iterator cend() const
Definition TrackCollection.h:212
TrackCollection & operator=(const TrackCollection &)=delete
const_iterator end() const
Definition TrackCollection.h:209
Definition TrackCollection.h:36
TrackCollectionIterator(const TrackCollectionIterator &)=delete
bool operator==(const TrackCollectionIterator &x) const
Definition TrackCollection.h:47
TrackCollectionIterator & operator=(const TrackCollectionIterator &)=delete
TrackCollectionIterator & operator++()
Definition TrackCollection.cc:386
Track * operator->()
Definition TrackCollection.cc:381
Track operator*()
Definition TrackCollection.cc:376
TrackCollectionIterator(size_t index, const TrackObjPointerContainer *collection)
Definition TrackCollection.h:38
bool operator!=(const TrackCollectionIterator &x) const
Definition TrackCollection.h:43
Definition Track.h:48
Definition TrackCollection.h:62
TrackMutableCollectionIterator(size_t index, const TrackObjPointerContainer *collection)
Definition TrackCollection.h:64
TrackMutableCollectionIterator & operator=(const TrackMutableCollectionIterator &)=delete
TrackMutableCollectionIterator(const TrackMutableCollectionIterator &)=delete
bool operator==(const TrackMutableCollectionIterator &x) const
Definition TrackCollection.h:73
MutableTrack * operator->()
Definition TrackCollection.cc:398
bool operator!=(const TrackMutableCollectionIterator &x) const
Definition TrackCollection.h:69
TrackMutableCollectionIterator & operator++()
Definition TrackCollection.cc:403
MutableTrack operator*()
Definition TrackCollection.cc:393
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