EDM4eic
EIC data model
Loading...
Searching...
No Matches
ProtoClusterCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_ProtoClusterCollection_H
4#define EDM4EIC_ProtoClusterCollection_H
5
6// datamodel specific includes
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 ProtoClusterCollectionIterator(size_t index, const ProtoClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ProtoClusterObj>{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 ProtoCluster m_object;
58 const ProtoClusterObjPointerContainer* m_collection;
59};
60
61
63public:
64 ProtoClusterMutableCollectionIterator(size_t index, const ProtoClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ProtoClusterObj>{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 MutableProtoCluster m_object;
84 const ProtoClusterObjPointerContainer* m_collection;
85};
86
87
88/**
89A Collection is identified by an ID.
90*/
91class ProtoClusterCollection : public podio::CollectionBase {
92public:
96 using difference_type = ptrdiff_t;
97 using size_type = size_t;
98
100 ProtoClusterCollection(ProtoClusterCollectionData&& data, bool isSubsetColl);
101 // This is a move-only type
106
107// ProtoClusterCollection(ProtoClusterVector* data, uint32_t collectionID);
108 ~ProtoClusterCollection() override;
109
110 constexpr static auto typeName = "edm4eic::ProtoClusterCollection";
111 constexpr static auto valueTypeName = "edm4eic::ProtoCluster";
112 constexpr static auto dataTypeName = "edm4eic::ProtoClusterData";
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 ProtoClusterCollection* operator->() { return static_cast<ProtoClusterCollection*>(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 MutableProtoCluster 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 ProtoCluster operator[](std::size_t index) const;
156 /// Returns the object of a given index
157 MutableProtoCluster operator[](std::size_t index);
158 /// Returns the const object of given index
159 ProtoCluster at(std::size_t index) const;
160 /// Returns the object of given index
161 MutableProtoCluster at(std::size_t index);
162
163
164 /// Append object to the collection
165 void push_back(const MutableProtoCluster& object);
166 /// Append an object to the (subset) collection
167 void push_back(const ProtoCluster& 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] (ProtoClusterObj* 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
217private:
218 // For setReferences, we need to give our own CollectionData access to our
219 // private entries. Otherwise we would need to expose a public member function
220 // that gives access to the Obj* which is definitely not what we want
222
223 bool m_isValid{false};
224 mutable bool m_isPrepared{false};
225 bool m_isSubsetColl{false};
226 uint32_t m_collectionID{0};
227 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
228 mutable ProtoClusterCollectionData m_storage{};
229};
230
231std::ostream& operator<<(std::ostream& o, const ProtoClusterCollection& v);
232
233template<typename... Args>
234MutableProtoCluster ProtoClusterCollection::create(Args&&... args) {
235 if (m_isSubsetColl) {
236 throw std::logic_error("Cannot create new elements on a subset collection");
237 }
238 const int size = m_storage.entries.size();
239 auto obj = new ProtoClusterObj({size, m_collectionID}, {std::forward<Args>(args)...});
240 m_storage.entries.push_back(obj);
241
242 // Need to initialize the relation vectors manually for the {ObjectID, ProtoClusterData} constructor
243 obj->m_hits = new std::vector<edm4eic::CalorimeterHit>();
244 obj->m_weights = new std::vector<float>();
245 m_storage.createRelations(obj);
246 return MutableProtoCluster(podio::utils::MaybeSharedPtr(obj));
247}
248
249#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
250void to_json(nlohmann::json& j, const ProtoClusterCollection& collection);
251#endif
252
253} // namespace edm4eic
254
255
256#endif
Definition MutableProtoCluster.h:35
Definition ProtoClusterCollectionData.h:31
ProtoClusterObjPointerContainer entries
Definition ProtoClusterCollectionData.h:36
Definition ProtoClusterCollection.h:91
ProtoClusterCollection(ProtoClusterCollection &&)=default
std::size_t max_size() const final
maximal number of elements in the collection
Definition ProtoClusterCollection.cc:55
bool isValid() const final
Definition ProtoClusterCollection.h:190
static constexpr auto dataTypeName
Definition ProtoClusterCollection.h:112
void push_back(const MutableProtoCluster &object)
Append object to the collection.
Definition ProtoClusterCollection.cc:131
const_iterator end() const
Definition ProtoClusterCollection.h:209
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition ProtoClusterCollection.cc:173
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition ProtoClusterCollection.cc:127
uint32_t getID() const final
Definition ProtoClusterCollection.h:186
bool isSubsetCollection() const final
Definition ProtoClusterCollection.h:148
static constexpr auto valueTypeName
Definition ProtoClusterCollection.h:111
ProtoClusterCollection()
Definition ProtoClusterCollection.cc:24
void prepareAfterRead() final
Definition ProtoClusterCollection.cc:112
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition ProtoClusterCollection.h:142
void prepareForWrite() const final
Definition ProtoClusterCollection.cc:91
MutableProtoCluster create()
Append a new object to the collection, and return this object.
Definition ProtoClusterCollection.cc:74
const std::string_view getTypeName() const final
fully qualified type name
Definition ProtoClusterCollection.h:140
~ProtoClusterCollection() override
Definition ProtoClusterCollection.cc:30
const_iterator begin() const
Definition ProtoClusterCollection.h:200
size_t size_type
Definition ProtoClusterCollection.h:97
ProtoClusterCollection(const ProtoClusterCollection &)=delete
std::size_t size() const final
number of elements in the collection
Definition ProtoClusterCollection.cc:51
void setID(uint32_t ID) final
Definition ProtoClusterCollection.h:176
void setSubsetCollection(bool setSubset=true) final
Definition ProtoClusterCollection.cc:63
static constexpr auto typeName
Definition ProtoClusterCollection.h:110
ProtoClusterCollection & operator=(const ProtoClusterCollection &)=delete
ProtoCluster at(std::size_t index) const
Returns the const object of given index.
Definition ProtoClusterCollection.cc:39
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition ProtoClusterCollection.h:144
iterator end()
Definition ProtoClusterCollection.h:206
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition ProtoClusterCollection.cc:340
ptrdiff_t difference_type
Definition ProtoClusterCollection.h:96
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition ProtoClusterCollection.cc:164
void clear() final
Definition ProtoClusterCollection.cc:86
ProtoClusterCollection & operator=(ProtoClusterCollection &&)=default
const_iterator cend() const
Definition ProtoClusterCollection.h:212
const_iterator cbegin() const
Definition ProtoClusterCollection.h:203
bool empty() const final
Is the collection empty.
Definition ProtoClusterCollection.cc:59
Definition ProtoClusterCollection.h:36
ProtoClusterCollectionIterator(const ProtoClusterCollectionIterator &)=delete
ProtoCluster * operator->()
Definition ProtoClusterCollection.cc:284
ProtoClusterCollectionIterator(size_t index, const ProtoClusterObjPointerContainer *collection)
Definition ProtoClusterCollection.h:38
ProtoClusterCollectionIterator & operator=(const ProtoClusterCollectionIterator &)=delete
ProtoClusterCollectionIterator & operator++()
Definition ProtoClusterCollection.cc:289
ProtoCluster operator*()
Definition ProtoClusterCollection.cc:279
bool operator==(const ProtoClusterCollectionIterator &x) const
Definition ProtoClusterCollection.h:47
bool operator!=(const ProtoClusterCollectionIterator &x) const
Definition ProtoClusterCollection.h:43
Definition ProtoCluster.h:43
Definition ProtoClusterCollection.h:62
bool operator==(const ProtoClusterMutableCollectionIterator &x) const
Definition ProtoClusterCollection.h:73
MutableProtoCluster * operator->()
Definition ProtoClusterCollection.cc:301
MutableProtoCluster operator*()
Definition ProtoClusterCollection.cc:296
ProtoClusterMutableCollectionIterator & operator=(const ProtoClusterMutableCollectionIterator &)=delete
bool operator!=(const ProtoClusterMutableCollectionIterator &x) const
Definition ProtoClusterCollection.h:69
ProtoClusterMutableCollectionIterator(size_t index, const ProtoClusterObjPointerContainer *collection)
Definition ProtoClusterCollection.h:64
ProtoClusterMutableCollectionIterator & operator++()
Definition ProtoClusterCollection.cc:306
ProtoClusterMutableCollectionIterator(const ProtoClusterMutableCollectionIterator &)=delete
Definition ProtoClusterObj.h:20
std::vector< edm4eic::CalorimeterHit > * m_hits
Definition ProtoClusterObj.h:36
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
std::deque< ProtoClusterObj * > ProtoClusterObjPointerContainer
Definition ProtoClusterCollectionData.h:23
Definition CalorimeterHit.h:31