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