EDM4eic
EIC data model
Loading...
Searching...
No Matches
CalorimeterHitCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_CalorimeterHitCollection_H
4#define EDM4EIC_CalorimeterHitCollection_H
5
6// datamodel specific includes
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 CalorimeterHitCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<CalorimeterHitObj>{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 CalorimeterHit m_object;
62 const CalorimeterHitObjPointerContainer* m_collection;
63};
64
65
67public:
68 CalorimeterHitMutableCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<CalorimeterHitObj>{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 MutableCalorimeterHit m_object;
88 const CalorimeterHitObjPointerContainer* m_collection;
89};
90
91
92/**
93A Collection is identified by an ID.
94*/
95class CalorimeterHitCollection : public podio::CollectionBase {
96public:
100
103 // This is a move-only type
108
109// CalorimeterHitCollection(CalorimeterHitVector* data, uint32_t collectionID);
111
112 constexpr static auto typeName = "edm4eic::CalorimeterHitCollection";
113 constexpr static auto valueTypeName = "edm4eic::CalorimeterHit";
114 constexpr static auto dataTypeName = "edm4eic::CalorimeterHitData";
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 CalorimeterHitCollection* operator->() { return (CalorimeterHitCollection*) 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 MutableCalorimeterHit 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 CalorimeterHit operator[](std::size_t index) const;
155 /// Returns the object of a given index
156 MutableCalorimeterHit operator[](std::size_t index);
157 /// Returns the const object of given index
158 CalorimeterHit at(std::size_t index) const;
159 /// Returns the object of given index
160 MutableCalorimeterHit at(std::size_t index);
161
162
163 /// Append object to the collection
164 void push_back(MutableCalorimeterHit object);
165 /// Append an object to the (subset) collection
166 void push_back(CalorimeterHit 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] (CalorimeterHitObj* 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::uint64_t> cellID(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<edm4hep::Vector3f> position(const size_t nElem = 0) const;
215 std::vector<edm4hep::Vector3f> dimension(const size_t nElem = 0) const;
216 std::vector<std::int32_t> sector(const size_t nElem = 0) const;
217 std::vector<std::int32_t> layer(const size_t nElem = 0) const;
218 std::vector<edm4hep::Vector3f> local(const size_t nElem = 0) const;
219
220private:
221 // For setReferences, we need to give our own CollectionData access to our
222 // private entries. Otherwise we would need to expose a public member function
223 // that gives access to the Obj* which is definitely not what we want
225
226 bool m_isValid{false};
227 mutable bool m_isPrepared{false};
228 bool m_isSubsetColl{false};
229 uint32_t m_collectionID{0};
230 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
231 mutable CalorimeterHitCollectionData m_storage{};
232};
233
234std::ostream& operator<<(std::ostream& o, const CalorimeterHitCollection& v);
235
236template<typename... Args>
237MutableCalorimeterHit CalorimeterHitCollection::create(Args&&... args) {
238 if (m_isSubsetColl) {
239 throw std::logic_error("Cannot create new elements on a subset collection");
240 }
241 const int size = m_storage.entries.size();
242 auto obj = new CalorimeterHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
243 m_storage.entries.push_back(obj);
244
245 return MutableCalorimeterHit(podio::utils::MaybeSharedPtr(obj));
246}
247
248#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
249void to_json(nlohmann::json& j, const CalorimeterHitCollection& collection);
250#endif
251
252} // namespace edm4eic
253
254
255#endif
Definition CalorimeterHitCollectionData.h:31
CalorimeterHitObjPointerContainer entries
Definition CalorimeterHitCollectionData.h:36
Definition CalorimeterHitCollection.h:95
static constexpr auto typeName
Definition CalorimeterHitCollection.h:112
void push_back(MutableCalorimeterHit object)
Append object to the collection.
Definition CalorimeterHitCollection.cc:125
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition CalorimeterHitCollection.cc:121
MutableCalorimeterHit create()
Append a new object to the collection, and return this object.
Definition CalorimeterHitCollection.cc:69
void setID(uint32_t ID) final
Definition CalorimeterHitCollection.h:175
const_iterator end() const
Definition CalorimeterHitCollection.h:205
static constexpr auto valueTypeName
Definition CalorimeterHitCollection.h:113
bool empty() const final
Is the collection empty.
Definition CalorimeterHitCollection.cc:54
~CalorimeterHitCollection()
Definition CalorimeterHitCollection.cc:29
CalorimeterHitCollection(CalorimeterHitCollection &&)=default
void setSubsetCollection(bool setSubset=true) final
Definition CalorimeterHitCollection.cc:58
uint32_t getID() const final
Definition CalorimeterHitCollection.h:185
bool isSubsetCollection() const final
Definition CalorimeterHitCollection.h:147
std::size_t size() const final
number of elements in the collection
Definition CalorimeterHitCollection.cc:50
bool isValid() const final
Definition CalorimeterHitCollection.h:189
CalorimeterHitCollection(const CalorimeterHitCollection &)=delete
iterator end()
Definition CalorimeterHitCollection.h:202
const_iterator begin() const
Definition CalorimeterHitCollection.h:199
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition CalorimeterHitCollection.h:141
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition CalorimeterHitCollection.cc:427
CalorimeterHitCollection & operator=(const CalorimeterHitCollection &)=delete
void prepareForWrite() const final
Definition CalorimeterHitCollection.cc:85
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition CalorimeterHitCollection.cc:266
CalorimeterHit at(std::size_t index) const
Returns the const object of given index.
Definition CalorimeterHitCollection.cc:38
CalorimeterHitCollection()
Definition CalorimeterHitCollection.cc:23
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition CalorimeterHitCollection.cc:157
void clear() final
Definition CalorimeterHitCollection.cc:80
void prepareAfterRead() final
Definition CalorimeterHitCollection.cc:106
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition CalorimeterHitCollection.h:143
static constexpr auto dataTypeName
Definition CalorimeterHitCollection.h:114
const std::string_view getTypeName() const final
fully qualified type name
Definition CalorimeterHitCollection.h:139
CalorimeterHitCollection & operator=(CalorimeterHitCollection &&)=default
Definition CalorimeterHitCollection.h:40
CalorimeterHit operator*()
Definition CalorimeterHitCollection.cc:364
CalorimeterHitCollectionIterator & operator=(const CalorimeterHitCollectionIterator &)=delete
CalorimeterHitCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer *collection)
Definition CalorimeterHitCollection.h:42
CalorimeterHitCollectionIterator(const CalorimeterHitCollectionIterator &)=delete
CalorimeterHitCollectionIterator & operator++()
Definition CalorimeterHitCollection.cc:374
CalorimeterHit * operator->()
Definition CalorimeterHitCollection.cc:369
bool operator==(const CalorimeterHitCollectionIterator &x) const
Definition CalorimeterHitCollection.h:51
bool operator!=(const CalorimeterHitCollectionIterator &x) const
Definition CalorimeterHitCollection.h:47
Definition CalorimeterHit.h:37
Definition CalorimeterHitCollection.h:66
bool operator!=(const CalorimeterHitMutableCollectionIterator &x) const
Definition CalorimeterHitCollection.h:73
CalorimeterHitMutableCollectionIterator & operator++()
Definition CalorimeterHitCollection.cc:391
CalorimeterHitMutableCollectionIterator(size_t index, const CalorimeterHitObjPointerContainer *collection)
Definition CalorimeterHitCollection.h:68
bool operator==(const CalorimeterHitMutableCollectionIterator &x) const
Definition CalorimeterHitCollection.h:77
CalorimeterHitMutableCollectionIterator & operator=(const CalorimeterHitMutableCollectionIterator &)=delete
MutableCalorimeterHit * operator->()
Definition CalorimeterHitCollection.cc:386
CalorimeterHitMutableCollectionIterator(const CalorimeterHitMutableCollectionIterator &)=delete
MutableCalorimeterHit operator*()
Definition CalorimeterHitCollection.cc:381
Definition CalorimeterHitObj.h:21
Definition MutableCalorimeterHit.h:36
Definition CalorimeterHit.cc:18
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:97
std::deque< CalorimeterHitObj * > CalorimeterHitObjPointerContainer
Definition CalorimeterHitCollectionData.h:23
Definition CalorimeterHitCollection.h:32