EICd
EIC data model
PMTHitCollection.h
Go to the documentation of this file.
1 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2 
3 #ifndef EICD_PMTHitCollection_H
4 #define EICD_PMTHitCollection_H
5 
6 // datamodel specific includes
7 #include "eicd/PMTHitData.h"
8 #include "eicd/PMTHit.h"
9 #include "eicd/PMTHitObj.h"
10 
11 // podio specific includes
12 #include "podio/ICollectionProvider.h"
13 #include "podio/CollectionBase.h"
14 #include "podio/CollectionIDTable.h"
15 
16 #include <string>
17 #include <vector>
18 #include <deque>
19 #include <array>
20 #include <algorithm>
21 #include <ostream>
22 
23 namespace eic {
24 
25 
26 using PMTHitDataContainer = std::vector<PMTHitData>;
27 using PMTHitObjPointerContainer = std::deque<PMTHitObj*>;
28 
30 public:
31  PMTHitCollectionIterator(size_t index, const PMTHitObjPointerContainer* collection) : m_index(index), m_object(nullptr), m_collection(collection) {}
32 
35 
36  bool operator!=(const PMTHitCollectionIterator& x) const {
37  return m_index != x.m_index; // TODO: may not be complete
38  }
39 
40  PMTHit operator*();
41  PMTHit* operator->();
43 
44 private:
45  size_t m_index;
46  PMTHit m_object;
47  const PMTHitObjPointerContainer* m_collection;
48 };
49 
50 
52 public:
53  PMTHitConstCollectionIterator(size_t index, const PMTHitObjPointerContainer* collection) : m_index(index), m_object(nullptr), m_collection(collection) {}
54 
57 
59  return m_index != x.m_index; // TODO: may not be complete
60  }
61 
65 
66 private:
67  size_t m_index;
68  ConstPMTHit m_object;
69  const PMTHitObjPointerContainer* m_collection;
70 };
71 
72 
73 /**
74 A Collection is identified by an ID.
75 */
76 class PMTHitCollection : public podio::CollectionBase {
77 
78 public:
81 
85 // PMTHitCollection(PMTHitVector* data, int collectionID);
87 
88  void clear() override final;
89 
90  /// operator to allow pointer like calling of members a la LCIO
91  PMTHitCollection* operator->() { return (PMTHitCollection*) this; }
92 
93  /// Append a new object to the collection, and return this object.
94  PMTHit create();
95 
96  /// Append a new object to the collection, and return this object.
97  /// Initialized with the parameters given
98  template<typename... Args>
99  PMTHit create(Args&&... args);
100 
101  /// number of elements in the collection
102  size_t size() const override final;
103 
104  /// fully qualified type name of elements - with namespace
105  std::string getValueTypeName() const override { return std::string("eic::PMTHit"); }
106 
107  /// Returns the const object of given index
108  ConstPMTHit operator[](unsigned int index) const;
109  /// Returns the object of a given index
110  PMTHit operator[](unsigned int index);
111  /// Returns the const object of given index
112  ConstPMTHit at(unsigned int index) const;
113  /// Returns the object of given index
114  PMTHit at(unsigned int index);
115 
116 
117  /// Append object to the collection
118  void push_back(ConstPMTHit object);
119 
120  void prepareForWrite() override final;
121  void prepareAfterRead() override final;
122  void setBuffer(void* address) override final;
123  bool setReferences(const podio::ICollectionProvider* collectionProvider) override final;
124 
125  podio::CollRefCollection* referenceCollections() override final { return &m_refCollections; }
126 
127  podio::VectorMembersInfo* vectorMembers() override { return &m_vecmem_info; }
128 
129  void setID(unsigned ID) override final {
130  m_collectionID = ID;
131  std::for_each(m_entries.begin(),m_entries.end(),
132  [ID] (PMTHitObj* obj) { obj->id = {obj->id.index, static_cast<int>(ID)}; }
133  );
134  m_isValid = true;
135  };
136 
137  unsigned getID() const override final {
138  return m_collectionID;
139  }
140 
141  bool isValid() const override final {
142  return m_isValid;
143  }
144 
145  // support for the iterator protocol
147  return iterator(0, &m_entries);
148  }
150  return const_iterator(0, &m_entries);
151  }
153  return iterator(m_entries.size(), &m_entries);
154  }
155  const_iterator end() const {
156  return const_iterator(m_entries.size(), &m_entries);
157  }
158 
159  /// returns the address of the pointer to the data buffer
160  void* getBufferAddress() override final { return (void*)&m_data; }
161 
162  /// Returns the pointer to the data buffer
163  std::vector<PMTHitData>* _getBuffer() { return m_data; }
164 
165  template<size_t arraysize>
166  const std::array<eic::Index, arraysize> ID() const;
167  template<size_t arraysize>
168  const std::array<std::int64_t, arraysize> cellID() const;
169  template<size_t arraysize>
170  const std::array<float, arraysize> npe() const;
171  template<size_t arraysize>
172  const std::array<float, arraysize> time() const;
173  template<size_t arraysize>
174  const std::array<float, arraysize> timeError() const;
175  template<size_t arraysize>
176  const std::array<eic::VectorXYZ, arraysize> position() const;
177  template<size_t arraysize>
178  const std::array<eic::VectorXYZ, arraysize> local() const;
179  template<size_t arraysize>
180  const std::array<eic::VectorXYZ, arraysize> dimension() const;
181 
182 private:
183  bool m_isValid{false};
184  bool m_isReadFromFile{false};
185  int m_collectionID{0};
186  PMTHitObjPointerContainer m_entries;
187 
188  // members to handle 1-to-N-relations
189 
190  // members to handle vector members
191  // members to handle streaming
192  podio::CollRefCollection m_refCollections{};
193  podio::VectorMembersInfo m_vecmem_info{};
194  PMTHitDataContainer* m_data;
195 };
196 
197 std::ostream& operator<<(std::ostream& o, const PMTHitCollection& v);
198 
199 template<typename... Args>
200 PMTHit PMTHitCollection::create(Args&&... args) {
201  const int size = m_entries.size();
202  auto obj = new PMTHitObj({size, m_collectionID}, {args...});
203  m_entries.push_back(obj);
204  return PMTHit(obj);
205 }
206 
207 template<size_t arraysize>
208 const std::array<eic::Index, arraysize> PMTHitCollection::ID() const {
209  std::array<eic::Index, arraysize> tmp;
210  const auto valid_size = std::min(arraysize, m_entries.size());
211  for (unsigned i = 0; i < valid_size; ++i) {
212  tmp[i] = m_entries[i]->data.ID;
213  }
214  return tmp;
215 }
216 
217 template<size_t arraysize>
218 const std::array<std::int64_t, arraysize> PMTHitCollection::cellID() const {
219  std::array<std::int64_t, arraysize> tmp;
220  const auto valid_size = std::min(arraysize, m_entries.size());
221  for (unsigned i = 0; i < valid_size; ++i) {
222  tmp[i] = m_entries[i]->data.cellID;
223  }
224  return tmp;
225 }
226 
227 template<size_t arraysize>
228 const std::array<float, arraysize> PMTHitCollection::npe() const {
229  std::array<float, arraysize> tmp;
230  const auto valid_size = std::min(arraysize, m_entries.size());
231  for (unsigned i = 0; i < valid_size; ++i) {
232  tmp[i] = m_entries[i]->data.npe;
233  }
234  return tmp;
235 }
236 
237 template<size_t arraysize>
238 const std::array<float, arraysize> PMTHitCollection::time() const {
239  std::array<float, arraysize> tmp;
240  const auto valid_size = std::min(arraysize, m_entries.size());
241  for (unsigned i = 0; i < valid_size; ++i) {
242  tmp[i] = m_entries[i]->data.time;
243  }
244  return tmp;
245 }
246 
247 template<size_t arraysize>
248 const std::array<float, arraysize> PMTHitCollection::timeError() const {
249  std::array<float, arraysize> tmp;
250  const auto valid_size = std::min(arraysize, m_entries.size());
251  for (unsigned i = 0; i < valid_size; ++i) {
252  tmp[i] = m_entries[i]->data.timeError;
253  }
254  return tmp;
255 }
256 
257 template<size_t arraysize>
258 const std::array<eic::VectorXYZ, arraysize> PMTHitCollection::position() const {
259  std::array<eic::VectorXYZ, arraysize> tmp;
260  const auto valid_size = std::min(arraysize, m_entries.size());
261  for (unsigned i = 0; i < valid_size; ++i) {
262  tmp[i] = m_entries[i]->data.position;
263  }
264  return tmp;
265 }
266 
267 template<size_t arraysize>
268 const std::array<eic::VectorXYZ, arraysize> PMTHitCollection::local() const {
269  std::array<eic::VectorXYZ, arraysize> tmp;
270  const auto valid_size = std::min(arraysize, m_entries.size());
271  for (unsigned i = 0; i < valid_size; ++i) {
272  tmp[i] = m_entries[i]->data.local;
273  }
274  return tmp;
275 }
276 
277 template<size_t arraysize>
278 const std::array<eic::VectorXYZ, arraysize> PMTHitCollection::dimension() const {
279  std::array<eic::VectorXYZ, arraysize> tmp;
280  const auto valid_size = std::min(arraysize, m_entries.size());
281  for (unsigned i = 0; i < valid_size; ++i) {
282  tmp[i] = m_entries[i]->data.dimension;
283  }
284  return tmp;
285 }
286 
287 
288 } // namespace eic
289 
290 
291 #endif
eic::operator<<
std::ostream & operator<<(std::ostream &o, const ConstBasicParticle &value)
Definition: BasicParticle.cc:102
PMTHitData.h
eic::PMTHitObjPointerContainer
std::deque< PMTHitObj * > PMTHitObjPointerContainer
Definition: PMTHitCollection.h:27
eic::PMTHitCollection::size
size_t size() const override final
number of elements in the collection
Definition: PMTHitCollection.cc:39
eic::PMTHitCollection::setReferences
bool setReferences(const podio::ICollectionProvider *collectionProvider) override final
Definition: PMTHitCollection.cc:84
eic::PMTHitCollection::prepareForWrite
void prepareForWrite() override final
Definition: PMTHitCollection.cc:56
eic::PMTHitCollection::prepareAfterRead
void prepareAfterRead() override final
Definition: PMTHitCollection.cc:69
eic::PMTHitObj
Definition: PMTHitObj.h:18
eic::PMTHitCollection::end
const_iterator end() const
Definition: PMTHitCollection.h:155
eic::PMTHitDataContainer
std::vector< PMTHitData > PMTHitDataContainer
Definition: PMTHitCollection.h:26
eic::PMTHitCollection::~PMTHitCollection
~PMTHitCollection()
Definition: PMTHitCollection.cc:18
eic::PMTHitCollectionIterator::operator!=
bool operator!=(const PMTHitCollectionIterator &x) const
Definition: PMTHitCollection.h:36
eic::PMTHitCollection::getID
unsigned getID() const override final
Definition: PMTHitCollection.h:137
eic::PMTHitCollection::operator[]
ConstPMTHit operator[](unsigned int index) const
Returns the const object of given index.
Definition: PMTHitCollection.cc:23
eic
Definition: BasicParticle.cc:13
eic::PMTHitCollection::begin
const_iterator begin() const
Definition: PMTHitCollection.h:149
eic::PMTHitCollection::getValueTypeName
std::string getValueTypeName() const override
fully qualified type name of elements - with namespace
Definition: PMTHitCollection.h:105
eic::PMTHit
Definition: PMTHit.h:23
eic::PMTHitCollection::clear
void clear() override final
Definition: PMTHitCollection.cc:50
eic::PMTHitCollection::referenceCollections
podio::CollRefCollection * referenceCollections() override final
Definition: PMTHitCollection.h:125
eic::PMTHitConstCollectionIterator::PMTHitConstCollectionIterator
PMTHitConstCollectionIterator(const PMTHitConstCollectionIterator &)=delete
eic::PMTHitCollectionIterator::operator=
PMTHitCollectionIterator & operator=(const PMTHitCollectionIterator &)=delete
eic::PMTHitCollection::setBuffer
void setBuffer(void *address) override final
Definition: PMTHitCollection.cc:101
eic::PMTHitCollection
Definition: PMTHitCollection.h:76
eic::PMTHitCollection::create
PMTHit create()
Append a new object to the collection, and return this object.
Definition: PMTHitCollection.cc:43
PMTHitObj.h
eic::PMTHitCollection::at
ConstPMTHit at(unsigned int index) const
Returns the const object of given index.
Definition: PMTHitCollection.cc:27
eic::PMTHitConstCollectionIterator
Definition: PMTHitCollection.h:51
eic::PMTHitCollectionIterator::operator++
PMTHitCollectionIterator & operator++()
Definition: PMTHitCollection.cc:116
eic::PMTHitCollectionIterator::operator->
PMTHit * operator->()
Definition: PMTHitCollection.cc:111
eic::PMTHitConstCollectionIterator::PMTHitConstCollectionIterator
PMTHitConstCollectionIterator(size_t index, const PMTHitObjPointerContainer *collection)
Definition: PMTHitCollection.h:53
eic::PMTHitCollection::PMTHitCollection
PMTHitCollection()
Definition: PMTHitCollection.cc:13
eic::PMTHitCollection::vectorMembers
podio::VectorMembersInfo * vectorMembers() override
Definition: PMTHitCollection.h:127
eic::PMTHitCollectionIterator::PMTHitCollectionIterator
PMTHitCollectionIterator(size_t index, const PMTHitObjPointerContainer *collection)
Definition: PMTHitCollection.h:31
eic::PMTHitConstCollectionIterator::operator=
PMTHitConstCollectionIterator & operator=(const PMTHitConstCollectionIterator &)=delete
eic::PMTHitCollection::operator=
PMTHitCollection & operator=(const PMTHitCollection &)=delete
eic::PMTHitCollection::isValid
bool isValid() const override final
Definition: PMTHitCollection.h:141
eic::PMTHitConstCollectionIterator::operator->
ConstPMTHit * operator->()
Definition: PMTHitCollection.cc:128
PMTHit.h
eic::PMTHitCollectionIterator::operator*
PMTHit operator*()
Definition: PMTHitCollection.cc:106
eic::PMTHitCollection::ID
const std::array< eic::Index, arraysize > ID() const
Definition: PMTHitCollection.h:208
eic::PMTHitConstCollectionIterator::operator++
PMTHitConstCollectionIterator & operator++()
Definition: PMTHitCollection.cc:133
eic::ConstPMTHit
Definition: PMTHitConst.h:21
eic::PMTHitCollection::end
iterator end()
Definition: PMTHitCollection.h:152
eic::PMTHitCollectionIterator::PMTHitCollectionIterator
PMTHitCollectionIterator(const PMTHitCollectionIterator &)=delete
eic::PMTHitConstCollectionIterator::operator!=
bool operator!=(const PMTHitConstCollectionIterator &x) const
Definition: PMTHitCollection.h:58
eic::PMTHitConstCollectionIterator::operator*
ConstPMTHit operator*()
Definition: PMTHitCollection.cc:123
eic::PMTHitCollection::getBufferAddress
void * getBufferAddress() override final
returns the address of the pointer to the data buffer
Definition: PMTHitCollection.h:160
eic::PMTHitCollection::setID
void setID(unsigned ID) override final
Definition: PMTHitCollection.h:129
eic::PMTHitCollectionIterator
Definition: PMTHitCollection.h:29
eic::PMTHitCollection::push_back
void push_back(ConstPMTHit object)
Append object to the collection.
Definition: PMTHitCollection.cc:89
eic::PMTHitCollection::PMTHitCollection
PMTHitCollection(const PMTHitCollection &)=delete
eic::PMTHitCollection::_getBuffer
std::vector< PMTHitData > * _getBuffer()
Returns the pointer to the data buffer.
Definition: PMTHitCollection.h:163
eic::PMTHitCollection::begin
iterator begin()
Definition: PMTHitCollection.h:146