EDM4eic
EIC data model
Loading...
Searching...
No Matches
ClusterCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_ClusterCollection_H
4#define EDM4EIC_ClusterCollection_H
5
6// datamodel specific includes
8#include "edm4eic/Cluster.h"
10#include "edm4eic/ClusterObj.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 ClusterCollectionIterator(size_t index, const ClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ClusterObj>{nullptr}), m_collection(collection) {}
43
46
48 return m_index != x.m_index; // TODO: may not be complete
49 }
50
52 return m_index == x.m_index; // TODO: may not be complete
53 }
54
58
59private:
60 size_t m_index;
61 Cluster m_object;
62 const ClusterObjPointerContainer* m_collection;
63};
64
65
67public:
68 ClusterMutableCollectionIterator(size_t index, const ClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ClusterObj>{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 MutableCluster m_object;
88 const ClusterObjPointerContainer* m_collection;
89};
90
91
92/**
93A Collection is identified by an ID.
94*/
95class ClusterCollection : public podio::CollectionBase {
96public:
100
102 ClusterCollection(ClusterCollectionData&& data, bool isSubsetColl);
103 // This is a move-only type
108
109// ClusterCollection(ClusterVector* data, uint32_t collectionID);
111
112 constexpr static auto typeName = "edm4eic::ClusterCollection";
113 constexpr static auto valueTypeName = "edm4eic::Cluster";
114 constexpr static auto dataTypeName = "edm4eic::ClusterData";
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 ClusterCollection* operator->() { return (ClusterCollection*) 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 MutableCluster 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 Cluster operator[](std::size_t index) const;
155 /// Returns the object of a given index
156 MutableCluster operator[](std::size_t index);
157 /// Returns the const object of given index
158 Cluster at(std::size_t index) const;
159 /// Returns the object of given index
160 MutableCluster at(std::size_t index);
161
162
163 /// Append object to the collection
164 void push_back(MutableCluster object);
165 /// Append an object to the (subset) collection
166 void push_back(Cluster 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] (ClusterObj* 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> energy(const size_t nElem = 0) const;
211 std::vector<float> energyError(const size_t nElem = 0) const;
212 std::vector<float> time(const size_t nElem = 0) const;
213 std::vector<float> timeError(const size_t nElem = 0) const;
214 std::vector<std::uint32_t> nhits(const size_t nElem = 0) const;
215 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
216 std::vector<edm4eic::Cov3f> positionError(const size_t nElem = 0) const;
217 std::vector<float> intrinsicTheta(const size_t nElem = 0) const;
218 std::vector<float> intrinsicPhi(const size_t nElem = 0) const;
219 std::vector<edm4eic::Cov2f> intrinsicDirectionError(const size_t nElem = 0) const;
220
221private:
222 // For setReferences, we need to give our own CollectionData access to our
223 // private entries. Otherwise we would need to expose a public member function
224 // that gives access to the Obj* which is definitely not what we want
226
227 bool m_isValid{false};
228 mutable bool m_isPrepared{false};
229 bool m_isSubsetColl{false};
230 uint32_t m_collectionID{0};
231 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
232 mutable ClusterCollectionData m_storage{};
233};
234
235std::ostream& operator<<(std::ostream& o, const ClusterCollection& v);
236
237template<typename... Args>
238MutableCluster ClusterCollection::create(Args&&... args) {
239 if (m_isSubsetColl) {
240 throw std::logic_error("Cannot create new elements on a subset collection");
241 }
242 const int size = m_storage.entries.size();
243 auto obj = new ClusterObj({size, m_collectionID}, {std::forward<Args>(args)...});
244 m_storage.entries.push_back(obj);
245
246 // Need to initialize the relation vectors manually for the {ObjectID, ClusterData} constructor
247 obj->m_clusters = new std::vector<edm4eic::Cluster>();
248 obj->m_hits = new std::vector<edm4eic::CalorimeterHit>();
249 obj->m_particleIDs = new std::vector<edm4hep::ParticleID>();
250 obj->m_shapeParameters = new std::vector<float>();
251 obj->m_hitContributions = new std::vector<float>();
252 obj->m_subdetectorEnergies = new std::vector<float>();
253 m_storage.createRelations(obj);
254 return MutableCluster(podio::utils::MaybeSharedPtr(obj));
255}
256
257#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
258void to_json(nlohmann::json& j, const ClusterCollection& collection);
259#endif
260
261} // namespace edm4eic
262
263
264#endif
Definition ClusterCollectionData.h:32
ClusterObjPointerContainer entries
Definition ClusterCollectionData.h:37
Definition ClusterCollection.h:95
bool isSubsetCollection() const final
Definition ClusterCollection.h:147
void prepareAfterRead() final
Definition ClusterCollection.cc:109
void clear() final
Definition ClusterCollection.cc:83
bool empty() const final
Is the collection empty.
Definition ClusterCollection.cc:56
Cluster at(std::size_t index) const
Returns the const object of given index.
Definition ClusterCollection.cc:40
ClusterCollection & operator=(ClusterCollection &&)=default
std::size_t size() const final
number of elements in the collection
Definition ClusterCollection.cc:52
void setID(uint32_t ID) final
Definition ClusterCollection.h:175
ClusterCollection()
Definition ClusterCollection.cc:25
const_iterator begin() const
Definition ClusterCollection.h:199
ClusterCollection(const ClusterCollection &)=delete
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition ClusterCollection.h:143
const std::string_view getTypeName() const final
fully qualified type name
Definition ClusterCollection.h:139
iterator end()
Definition ClusterCollection.h:202
const_iterator end() const
Definition ClusterCollection.h:205
ClusterCollection & operator=(const ClusterCollection &)=delete
ClusterCollection(ClusterCollection &&)=default
void push_back(MutableCluster object)
Append object to the collection.
Definition ClusterCollection.cc:128
MutableCluster create()
Append a new object to the collection, and return this object.
Definition ClusterCollection.cc:71
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition ClusterCollection.cc:124
static constexpr auto valueTypeName
Definition ClusterCollection.h:113
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition ClusterCollection.h:141
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition ClusterCollection.cc:161
bool isValid() const final
Definition ClusterCollection.h:189
void setSubsetCollection(bool setSubset=true) final
Definition ClusterCollection.cc:60
static constexpr auto dataTypeName
Definition ClusterCollection.h:114
static constexpr auto typeName
Definition ClusterCollection.h:112
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition ClusterCollection.cc:280
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition ClusterCollection.cc:479
void prepareForWrite() const final
Definition ClusterCollection.cc:88
~ClusterCollection()
Definition ClusterCollection.cc:31
uint32_t getID() const final
Definition ClusterCollection.h:185
Definition ClusterCollection.h:40
ClusterCollectionIterator & operator=(const ClusterCollectionIterator &)=delete
Cluster * operator->()
Definition ClusterCollection.cc:392
bool operator==(const ClusterCollectionIterator &x) const
Definition ClusterCollection.h:51
bool operator!=(const ClusterCollectionIterator &x) const
Definition ClusterCollection.h:47
Cluster operator*()
Definition ClusterCollection.cc:387
ClusterCollectionIterator(const ClusterCollectionIterator &)=delete
ClusterCollectionIterator(size_t index, const ClusterObjPointerContainer *collection)
Definition ClusterCollection.h:42
ClusterCollectionIterator & operator++()
Definition ClusterCollection.cc:397
Definition Cluster.h:38
Definition ClusterCollection.h:66
ClusterMutableCollectionIterator(size_t index, const ClusterObjPointerContainer *collection)
Definition ClusterCollection.h:68
ClusterMutableCollectionIterator(const ClusterMutableCollectionIterator &)=delete
MutableCluster * operator->()
Definition ClusterCollection.cc:409
bool operator!=(const ClusterMutableCollectionIterator &x) const
Definition ClusterCollection.h:73
bool operator==(const ClusterMutableCollectionIterator &x) const
Definition ClusterCollection.h:77
ClusterMutableCollectionIterator & operator=(const ClusterMutableCollectionIterator &)=delete
ClusterMutableCollectionIterator & operator++()
Definition ClusterCollection.cc:414
MutableCluster operator*()
Definition ClusterCollection.cc:404
Definition ClusterObj.h:20
std::vector< edm4eic::Cluster > * m_clusters
Definition ClusterObj.h:36
Definition MutableCluster.h:37
Definition CalorimeterHit.cc:18
std::deque< ClusterObj * > ClusterObjPointerContainer
Definition ClusterCollectionData.h:24
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:97
Definition CalorimeterHitCollection.h:32