EDM4eic
EIC data model
Loading...
Searching...
No Matches
RingImageCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_RingImageCollection_H
4#define EDM4EIC_RingImageCollection_H
5
6// datamodel specific includes
7#include "edm4eic/RingImage.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 RingImageCollectionIterator(size_t index, const RingImageObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RingImageObj>{nullptr}), m_collection(collection) {}
39
42
44 return m_index != x.m_index; // TODO: may not be complete
45 }
46
48 return m_index == x.m_index; // TODO: may not be complete
49 }
50
54
55private:
56 size_t m_index;
57 RingImage m_object;
58 const RingImageObjPointerContainer* m_collection;
59};
60
61
63public:
64 RingImageMutableCollectionIterator(size_t index, const RingImageObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RingImageObj>{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 MutableRingImage m_object;
84 const RingImageObjPointerContainer* m_collection;
85};
86
87
88/**
89A Collection is identified by an ID.
90*/
91class RingImageCollection : public podio::CollectionBase {
92public:
96 using difference_type = ptrdiff_t;
97 using size_type = size_t;
98
100 RingImageCollection(RingImageCollectionData&& data, bool isSubsetColl);
101 // This is a move-only type
106
107// RingImageCollection(RingImageVector* data, uint32_t collectionID);
108 ~RingImageCollection() override;
109
110 constexpr static auto typeName = "edm4eic::RingImageCollection";
111 constexpr static auto valueTypeName = "edm4eic::RingImage";
112 constexpr static auto dataTypeName = "edm4eic::RingImageData";
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 RingImageCollection* operator->() { return static_cast<RingImageCollection*>(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 MutableRingImage 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 RingImage operator[](std::size_t index) const;
156 /// Returns the object of a given index
157 MutableRingImage operator[](std::size_t index);
158 /// Returns the const object of given index
159 RingImage at(std::size_t index) const;
160 /// Returns the object of given index
161 MutableRingImage at(std::size_t index);
162
163
164 /// Append object to the collection
165 void push_back(const MutableRingImage& object);
166 /// Append an object to the (subset) collection
167 void push_back(const RingImage& 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] (RingImageObj* 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<float> npe(const size_t nElem = 0) const;
217 std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
218 std::vector<edm4hep::Vector3f> positionError(const size_t nElem = 0) const;
219 std::vector<float> theta(const size_t nElem = 0) const;
220 std::vector<float> thetaError(const size_t nElem = 0) const;
221 std::vector<float> radius(const size_t nElem = 0) const;
222 std::vector<float> radiusError(const size_t nElem = 0) const;
223
224private:
225 // For setReferences, we need to give our own CollectionData access to our
226 // private entries. Otherwise we would need to expose a public member function
227 // that gives access to the Obj* which is definitely not what we want
229
230 bool m_isValid{false};
231 mutable bool m_isPrepared{false};
232 bool m_isSubsetColl{false};
233 uint32_t m_collectionID{0};
234 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
235 mutable RingImageCollectionData m_storage{};
236};
237
238std::ostream& operator<<(std::ostream& o, const RingImageCollection& v);
239
240template<typename... Args>
241MutableRingImage RingImageCollection::create(Args&&... args) {
242 if (m_isSubsetColl) {
243 throw std::logic_error("Cannot create new elements on a subset collection");
244 }
245 const int size = m_storage.entries.size();
246 auto obj = new RingImageObj({size, m_collectionID}, {std::forward<Args>(args)...});
247 m_storage.entries.push_back(obj);
248
249 return MutableRingImage(podio::utils::MaybeSharedPtr(obj));
250}
251
252#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
253void to_json(nlohmann::json& j, const RingImageCollection& collection);
254#endif
255
256} // namespace edm4eic
257
258
259#endif
Definition MutableRingImage.h:33
Definition RingImageCollectionData.h:30
RingImageObjPointerContainer entries
Definition RingImageCollectionData.h:35
Definition RingImageCollection.h:91
static constexpr auto typeName
Definition RingImageCollection.h:110
ptrdiff_t difference_type
Definition RingImageCollection.h:96
uint32_t getID() const final
Definition RingImageCollection.h:186
RingImageCollection()
Definition RingImageCollection.cc:22
RingImage at(std::size_t index) const
Returns the const object of given index.
Definition RingImageCollection.cc:37
RingImageCollection(RingImageCollection &&)=default
void setID(uint32_t ID) final
Definition RingImageCollection.h:176
const_iterator begin() const
Definition RingImageCollection.h:200
MutableRingImage create()
Append a new object to the collection, and return this object.
Definition RingImageCollection.cc:72
std::size_t size() const final
number of elements in the collection
Definition RingImageCollection.cc:49
RingImageCollection & operator=(const RingImageCollection &)=delete
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition RingImageCollection.cc:124
bool empty() const final
Is the collection empty.
Definition RingImageCollection.cc:57
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition RingImageCollection.cc:400
void prepareAfterRead() final
Definition RingImageCollection.cc:109
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition RingImageCollection.h:142
iterator end()
Definition RingImageCollection.h:206
void clear() final
Definition RingImageCollection.cc:83
void setSubsetCollection(bool setSubset=true) final
Definition RingImageCollection.cc:61
static constexpr auto dataTypeName
Definition RingImageCollection.h:112
size_t size_type
Definition RingImageCollection.h:97
const_iterator cend() const
Definition RingImageCollection.h:212
bool isValid() const final
Definition RingImageCollection.h:190
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition RingImageCollection.cc:239
RingImageCollection(const RingImageCollection &)=delete
bool isSubsetCollection() const final
Definition RingImageCollection.h:148
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition RingImageCollection.cc:160
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition RingImageCollection.h:144
void prepareForWrite() const final
Definition RingImageCollection.cc:88
const std::string_view getTypeName() const final
fully qualified type name
Definition RingImageCollection.h:140
static constexpr auto valueTypeName
Definition RingImageCollection.h:111
RingImageCollection & operator=(RingImageCollection &&)=default
void push_back(const MutableRingImage &object)
Append object to the collection.
Definition RingImageCollection.cc:128
~RingImageCollection() override
Definition RingImageCollection.cc:28
std::size_t max_size() const final
maximal number of elements in the collection
Definition RingImageCollection.cc:53
const_iterator cbegin() const
Definition RingImageCollection.h:203
const_iterator end() const
Definition RingImageCollection.h:209
Definition RingImageCollection.h:36
bool operator!=(const RingImageCollectionIterator &x) const
Definition RingImageCollection.h:43
RingImageCollectionIterator & operator=(const RingImageCollectionIterator &)=delete
bool operator==(const RingImageCollectionIterator &x) const
Definition RingImageCollection.h:47
RingImageCollectionIterator(const RingImageCollectionIterator &)=delete
RingImageCollectionIterator(size_t index, const RingImageObjPointerContainer *collection)
Definition RingImageCollection.h:38
RingImageCollectionIterator & operator++()
Definition RingImageCollection.cc:352
RingImage operator*()
Definition RingImageCollection.cc:342
RingImage * operator->()
Definition RingImageCollection.cc:347
Definition RingImage.h:41
Definition RingImageCollection.h:62
MutableRingImage * operator->()
Definition RingImageCollection.cc:364
bool operator==(const RingImageMutableCollectionIterator &x) const
Definition RingImageCollection.h:73
RingImageMutableCollectionIterator & operator++()
Definition RingImageCollection.cc:369
bool operator!=(const RingImageMutableCollectionIterator &x) const
Definition RingImageCollection.h:69
RingImageMutableCollectionIterator(size_t index, const RingImageObjPointerContainer *collection)
Definition RingImageCollection.h:64
RingImageMutableCollectionIterator & operator=(const RingImageMutableCollectionIterator &)=delete
MutableRingImage operator*()
Definition RingImageCollection.cc:359
RingImageMutableCollectionIterator(const RingImageMutableCollectionIterator &)=delete
Definition RingImageObj.h:17
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< RingImageObj * > RingImageObjPointerContainer
Definition RingImageCollectionData.h:22
Definition CalorimeterHit.h:31