EDM4eic
EIC data model
Loading...
Searching...
No Matches
RawTrackerHitCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_RawTrackerHitCollection_H
4#define EDM4EIC_RawTrackerHitCollection_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 RawTrackerHitCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RawTrackerHitObj>{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 RawTrackerHit m_object;
62 const RawTrackerHitObjPointerContainer* m_collection;
63};
64
65
67public:
68 RawTrackerHitMutableCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<RawTrackerHitObj>{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 MutableRawTrackerHit m_object;
88 const RawTrackerHitObjPointerContainer* m_collection;
89};
90
91
92/**
93A Collection is identified by an ID.
94*/
95class RawTrackerHitCollection : public podio::CollectionBase {
96public:
100
102 RawTrackerHitCollection(RawTrackerHitCollectionData&& data, bool isSubsetColl);
103 // This is a move-only type
108
109// RawTrackerHitCollection(RawTrackerHitVector* data, uint32_t collectionID);
111
112 constexpr static auto typeName = "edm4eic::RawTrackerHitCollection";
113 constexpr static auto valueTypeName = "edm4eic::RawTrackerHit";
114 constexpr static auto dataTypeName = "edm4eic::RawTrackerHitData";
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 RawTrackerHitCollection* operator->() { return (RawTrackerHitCollection*) 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 MutableRawTrackerHit 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 RawTrackerHit operator[](std::size_t index) const;
155 /// Returns the object of a given index
156 MutableRawTrackerHit operator[](std::size_t index);
157 /// Returns the const object of given index
158 RawTrackerHit at(std::size_t index) const;
159 /// Returns the object of given index
160 MutableRawTrackerHit at(std::size_t index);
161
162
163 /// Append object to the collection
164 void push_back(MutableRawTrackerHit object);
165 /// Append an object to the (subset) collection
166 void push_back(RawTrackerHit 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] (RawTrackerHitObj* 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<std::int32_t> charge(const size_t nElem = 0) const;
211 std::vector<std::int32_t> timeStamp(const size_t nElem = 0) const;
212
213private:
214 // For setReferences, we need to give our own CollectionData access to our
215 // private entries. Otherwise we would need to expose a public member function
216 // that gives access to the Obj* which is definitely not what we want
218
219 bool m_isValid{false};
220 mutable bool m_isPrepared{false};
221 bool m_isSubsetColl{false};
222 uint32_t m_collectionID{0};
223 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
224 mutable RawTrackerHitCollectionData m_storage{};
225};
226
227std::ostream& operator<<(std::ostream& o, const RawTrackerHitCollection& v);
228
229template<typename... Args>
230MutableRawTrackerHit RawTrackerHitCollection::create(Args&&... args) {
231 if (m_isSubsetColl) {
232 throw std::logic_error("Cannot create new elements on a subset collection");
233 }
234 const int size = m_storage.entries.size();
235 auto obj = new RawTrackerHitObj({size, m_collectionID}, {std::forward<Args>(args)...});
236 m_storage.entries.push_back(obj);
237
238 return MutableRawTrackerHit(podio::utils::MaybeSharedPtr(obj));
239}
240
241#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
242void to_json(nlohmann::json& j, const RawTrackerHitCollection& collection);
243#endif
244
245} // namespace edm4eic
246
247
248#endif
Definition MutableRawTrackerHit.h:30
Definition RawTrackerHitCollectionData.h:30
RawTrackerHitObjPointerContainer entries
Definition RawTrackerHitCollectionData.h:35
Definition RawTrackerHitCollection.h:95
RawTrackerHitCollection & operator=(RawTrackerHitCollection &&)=default
iterator end()
Definition RawTrackerHitCollection.h:202
void prepareForWrite() const final
Definition RawTrackerHitCollection.cc:84
RawTrackerHitCollection(const RawTrackerHitCollection &)=delete
RawTrackerHitCollection()
Definition RawTrackerHitCollection.cc:22
void setSubsetCollection(bool setSubset=true) final
Definition RawTrackerHitCollection.cc:57
uint32_t getID() const final
Definition RawTrackerHitCollection.h:185
const_iterator begin() const
Definition RawTrackerHitCollection.h:199
void setID(uint32_t ID) final
Definition RawTrackerHitCollection.h:175
bool isSubsetCollection() const final
Definition RawTrackerHitCollection.h:147
bool empty() const final
Is the collection empty.
Definition RawTrackerHitCollection.cc:53
const std::string_view getTypeName() const final
fully qualified type name
Definition RawTrackerHitCollection.h:139
static constexpr auto dataTypeName
Definition RawTrackerHitCollection.h:114
static constexpr auto typeName
Definition RawTrackerHitCollection.h:112
RawTrackerHitCollection(RawTrackerHitCollection &&)=default
void push_back(MutableRawTrackerHit object)
Append object to the collection.
Definition RawTrackerHitCollection.cc:124
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition RawTrackerHitCollection.cc:347
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition RawTrackerHitCollection.h:141
RawTrackerHit at(std::size_t index) const
Returns the const object of given index.
Definition RawTrackerHitCollection.cc:37
const_iterator end() const
Definition RawTrackerHitCollection.h:205
MutableRawTrackerHit create()
Append a new object to the collection, and return this object.
Definition RawTrackerHitCollection.cc:68
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition RawTrackerHitCollection.cc:120
RawTrackerHitCollection & operator=(const RawTrackerHitCollection &)=delete
bool isValid() const final
Definition RawTrackerHitCollection.h:189
void clear() final
Definition RawTrackerHitCollection.cc:79
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition RawTrackerHitCollection.cc:195
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition RawTrackerHitCollection.cc:156
void prepareAfterRead() final
Definition RawTrackerHitCollection.cc:105
static constexpr auto valueTypeName
Definition RawTrackerHitCollection.h:113
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition RawTrackerHitCollection.h:143
~RawTrackerHitCollection()
Definition RawTrackerHitCollection.cc:28
std::size_t size() const final
number of elements in the collection
Definition RawTrackerHitCollection.cc:49
Definition RawTrackerHitCollection.h:40
RawTrackerHit operator*()
Definition RawTrackerHitCollection.cc:293
RawTrackerHit * operator->()
Definition RawTrackerHitCollection.cc:298
bool operator!=(const RawTrackerHitCollectionIterator &x) const
Definition RawTrackerHitCollection.h:47
RawTrackerHitCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer *collection)
Definition RawTrackerHitCollection.h:42
bool operator==(const RawTrackerHitCollectionIterator &x) const
Definition RawTrackerHitCollection.h:51
RawTrackerHitCollectionIterator(const RawTrackerHitCollectionIterator &)=delete
RawTrackerHitCollectionIterator & operator=(const RawTrackerHitCollectionIterator &)=delete
RawTrackerHitCollectionIterator & operator++()
Definition RawTrackerHitCollection.cc:303
Definition RawTrackerHit.h:31
Definition RawTrackerHitCollection.h:66
RawTrackerHitMutableCollectionIterator & operator++()
Definition RawTrackerHitCollection.cc:320
MutableRawTrackerHit operator*()
Definition RawTrackerHitCollection.cc:310
RawTrackerHitMutableCollectionIterator & operator=(const RawTrackerHitMutableCollectionIterator &)=delete
RawTrackerHitMutableCollectionIterator(size_t index, const RawTrackerHitObjPointerContainer *collection)
Definition RawTrackerHitCollection.h:68
MutableRawTrackerHit * operator->()
Definition RawTrackerHitCollection.cc:315
RawTrackerHitMutableCollectionIterator(const RawTrackerHitMutableCollectionIterator &)=delete
bool operator!=(const RawTrackerHitMutableCollectionIterator &x) const
Definition RawTrackerHitCollection.h:73
bool operator==(const RawTrackerHitMutableCollectionIterator &x) const
Definition RawTrackerHitCollection.h:77
Definition RawTrackerHitObj.h:17
Definition CalorimeterHit.cc:18
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:97
std::deque< RawTrackerHitObj * > RawTrackerHitObjPointerContainer
Definition RawTrackerHitCollectionData.h:22
Definition CalorimeterHitCollection.h:32