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
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 ProtoClusterCollectionIterator(size_t index, const ProtoClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ProtoClusterObj>{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 ProtoCluster m_object;
62 const ProtoClusterObjPointerContainer* m_collection;
63};
64
65
67public:
68 ProtoClusterMutableCollectionIterator(size_t index, const ProtoClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ProtoClusterObj>{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 MutableProtoCluster m_object;
88 const ProtoClusterObjPointerContainer* m_collection;
89};
90
91
92/**
93A Collection is identified by an ID.
94*/
95class ProtoClusterCollection : public podio::CollectionBase {
96public:
100
102 ProtoClusterCollection(ProtoClusterCollectionData&& data, bool isSubsetColl);
103 // This is a move-only type
108
109// ProtoClusterCollection(ProtoClusterVector* data, uint32_t collectionID);
111
112 constexpr static auto typeName = "edm4eic::ProtoClusterCollection";
113 constexpr static auto valueTypeName = "edm4eic::ProtoCluster";
114 constexpr static auto dataTypeName = "edm4eic::ProtoClusterData";
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 ProtoClusterCollection* operator->() { return (ProtoClusterCollection*) 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 MutableProtoCluster 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 ProtoCluster operator[](std::size_t index) const;
155 /// Returns the object of a given index
156 MutableProtoCluster operator[](std::size_t index);
157 /// Returns the const object of given index
158 ProtoCluster at(std::size_t index) const;
159 /// Returns the object of given index
160 MutableProtoCluster at(std::size_t index);
161
162
163 /// Append object to the collection
164 void push_back(MutableProtoCluster object);
165 /// Append an object to the (subset) collection
166 void push_back(ProtoCluster 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] (ProtoClusterObj* 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
210private:
211 // For setReferences, we need to give our own CollectionData access to our
212 // private entries. Otherwise we would need to expose a public member function
213 // that gives access to the Obj* which is definitely not what we want
215
216 bool m_isValid{false};
217 mutable bool m_isPrepared{false};
218 bool m_isSubsetColl{false};
219 uint32_t m_collectionID{0};
220 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
221 mutable ProtoClusterCollectionData m_storage{};
222};
223
224std::ostream& operator<<(std::ostream& o, const ProtoClusterCollection& v);
225
226template<typename... Args>
227MutableProtoCluster ProtoClusterCollection::create(Args&&... args) {
228 if (m_isSubsetColl) {
229 throw std::logic_error("Cannot create new elements on a subset collection");
230 }
231 const int size = m_storage.entries.size();
232 auto obj = new ProtoClusterObj({size, m_collectionID}, {std::forward<Args>(args)...});
233 m_storage.entries.push_back(obj);
234
235 // Need to initialize the relation vectors manually for the {ObjectID, ProtoClusterData} constructor
236 obj->m_hits = new std::vector<edm4eic::CalorimeterHit>();
237 obj->m_weights = new std::vector<float>();
238 m_storage.createRelations(obj);
239 return MutableProtoCluster(podio::utils::MaybeSharedPtr(obj));
240}
241
242#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
243void to_json(nlohmann::json& j, const ProtoClusterCollection& collection);
244#endif
245
246} // namespace edm4eic
247
248
249#endif
Definition MutableProtoCluster.h:32
Definition ProtoClusterCollectionData.h:31
ProtoClusterObjPointerContainer entries
Definition ProtoClusterCollectionData.h:36
Definition ProtoClusterCollection.h:95
ProtoClusterCollection(ProtoClusterCollection &&)=default
bool isValid() const final
Definition ProtoClusterCollection.h:189
static constexpr auto dataTypeName
Definition ProtoClusterCollection.h:114
const_iterator end() const
Definition ProtoClusterCollection.h:205
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition ProtoClusterCollection.cc:169
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition ProtoClusterCollection.cc:123
uint32_t getID() const final
Definition ProtoClusterCollection.h:185
bool isSubsetCollection() const final
Definition ProtoClusterCollection.h:147
static constexpr auto valueTypeName
Definition ProtoClusterCollection.h:113
~ProtoClusterCollection()
Definition ProtoClusterCollection.cc:30
ProtoClusterCollection()
Definition ProtoClusterCollection.cc:24
void prepareAfterRead() final
Definition ProtoClusterCollection.cc:108
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition ProtoClusterCollection.h:141
void prepareForWrite() const final
Definition ProtoClusterCollection.cc:87
MutableProtoCluster create()
Append a new object to the collection, and return this object.
Definition ProtoClusterCollection.cc:70
const std::string_view getTypeName() const final
fully qualified type name
Definition ProtoClusterCollection.h:139
const_iterator begin() const
Definition ProtoClusterCollection.h:199
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:175
void setSubsetCollection(bool setSubset=true) final
Definition ProtoClusterCollection.cc:59
static constexpr auto typeName
Definition ProtoClusterCollection.h:112
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:143
iterator end()
Definition ProtoClusterCollection.h:202
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition ProtoClusterCollection.cc:331
void push_back(MutableProtoCluster object)
Append object to the collection.
Definition ProtoClusterCollection.cc:127
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition ProtoClusterCollection.cc:160
void clear() final
Definition ProtoClusterCollection.cc:82
ProtoClusterCollection & operator=(ProtoClusterCollection &&)=default
bool empty() const final
Is the collection empty.
Definition ProtoClusterCollection.cc:55
Definition ProtoClusterCollection.h:40
ProtoClusterCollectionIterator(const ProtoClusterCollectionIterator &)=delete
ProtoCluster * operator->()
Definition ProtoClusterCollection.cc:275
ProtoClusterCollectionIterator(size_t index, const ProtoClusterObjPointerContainer *collection)
Definition ProtoClusterCollection.h:42
ProtoClusterCollectionIterator & operator=(const ProtoClusterCollectionIterator &)=delete
ProtoClusterCollectionIterator & operator++()
Definition ProtoClusterCollection.cc:280
ProtoCluster operator*()
Definition ProtoClusterCollection.cc:270
bool operator==(const ProtoClusterCollectionIterator &x) const
Definition ProtoClusterCollection.h:51
bool operator!=(const ProtoClusterCollectionIterator &x) const
Definition ProtoClusterCollection.h:47
Definition ProtoCluster.h:33
Definition ProtoClusterCollection.h:66
bool operator==(const ProtoClusterMutableCollectionIterator &x) const
Definition ProtoClusterCollection.h:77
MutableProtoCluster * operator->()
Definition ProtoClusterCollection.cc:292
MutableProtoCluster operator*()
Definition ProtoClusterCollection.cc:287
ProtoClusterMutableCollectionIterator & operator=(const ProtoClusterMutableCollectionIterator &)=delete
bool operator!=(const ProtoClusterMutableCollectionIterator &x) const
Definition ProtoClusterCollection.h:73
ProtoClusterMutableCollectionIterator(size_t index, const ProtoClusterObjPointerContainer *collection)
Definition ProtoClusterCollection.h:68
ProtoClusterMutableCollectionIterator & operator++()
Definition ProtoClusterCollection.cc:297
ProtoClusterMutableCollectionIterator(const ProtoClusterMutableCollectionIterator &)=delete
Definition ProtoClusterObj.h:19
std::vector< edm4eic::CalorimeterHit > * m_hits
Definition ProtoClusterObj.h:35
Definition CalorimeterHit.cc:18
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:97
std::deque< ProtoClusterObj * > ProtoClusterObjPointerContainer
Definition ProtoClusterCollectionData.h:23
Definition CalorimeterHitCollection.h:32