include/edm4eic/InclusiveKinematicsCollection.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_InclusiveKinematicsCollection_H
0004 #define EDM4EIC_InclusiveKinematicsCollection_H
0005
0006 // datamodel specific includes
0007 #include "edm4eic/InclusiveKinematicsData.h"
0008 #include "edm4eic/InclusiveKinematics.h"
0009 #include "edm4eic/MutableInclusiveKinematics.h"
0010 #include "edm4eic/InclusiveKinematicsObj.h"
0011 #include "edm4eic/InclusiveKinematicsCollectionData.h"
0012
0013 // podio specific includes
0014 #include "podio/ICollectionProvider.h"
0015 #include "podio/CollectionBase.h"
0016 #include "podio/CollectionIDTable.h"
0017
0018 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0019 #include "nlohmann/json_fwd.hpp"
0020 #endif
0021
0022 #include <string>
0023 #include <vector>
0024 #include <deque>
0025 #include <array>
0026 #include <algorithm>
0027 #include <ostream>
0028 #include <mutex>
0029 #include <memory>
0030 #include <cstddef>
0031
0032 namespace podio {
0033   struct RelationNames;
0034 }
0035
0036 namespace edm4eic {
0037
0038
0039
0040 class InclusiveKinematicsCollectionIterator {
0041 public:
0042   InclusiveKinematicsCollectionIterator(size_t index, const InclusiveKinematicsObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<InclusiveKinematicsObj>{nullptr}), m_collection(collection) {}
0043
0044   InclusiveKinematicsCollectionIterator(const InclusiveKinematicsCollectionIterator&) = delete;
0045   InclusiveKinematicsCollectionIterator& operator=(const InclusiveKinematicsCollectionIterator&) = delete;
0046
0047   bool operator!=(const InclusiveKinematicsCollectionIterator& x) const {
0048     return m_index != x.m_index; // TODO: may not be complete
0049   }
0050
0051   bool operator==(const InclusiveKinematicsCollectionIterator& x) const {
0052     return m_index ==  x.m_index; // TODO: may not be complete
0053   }
0054
0055   InclusiveKinematics operator*();
0056   InclusiveKinematics* operator->();
0057   InclusiveKinematicsCollectionIterator& operator++();
0058
0059 private:
0060   size_t m_index;
0061   InclusiveKinematics m_object;
0062   const InclusiveKinematicsObjPointerContainer* m_collection;
0063 };
0064
0065
0066 class InclusiveKinematicsMutableCollectionIterator {
0067 public:
0068   InclusiveKinematicsMutableCollectionIterator(size_t index, const InclusiveKinematicsObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<InclusiveKinematicsObj>{nullptr}), m_collection(collection) {}
0069
0070   InclusiveKinematicsMutableCollectionIterator(const InclusiveKinematicsMutableCollectionIterator&) = delete;
0071   InclusiveKinematicsMutableCollectionIterator& operator=(const InclusiveKinematicsMutableCollectionIterator&) = delete;
0072
0073   bool operator!=(const InclusiveKinematicsMutableCollectionIterator& x) const {
0074     return m_index != x.m_index; // TODO: may not be complete
0075   }
0076
0077   bool operator==(const InclusiveKinematicsMutableCollectionIterator& x) const {
0078     return m_index ==  x.m_index; // TODO: may not be complete
0079   }
0080
0081   MutableInclusiveKinematics operator*();
0082   MutableInclusiveKinematics* operator->();
0083   InclusiveKinematicsMutableCollectionIterator& operator++();
0084
0085 private:
0086   size_t m_index;
0087   MutableInclusiveKinematics m_object;
0088   const InclusiveKinematicsObjPointerContainer* m_collection;
0089 };
0090
0091
0092 /**
0093 A Collection is identified by an ID.
0094 */
0095 class InclusiveKinematicsCollection : public podio::CollectionBase {
0096 public:
0097   using value_type = InclusiveKinematics;
0098   using const_iterator = InclusiveKinematicsCollectionIterator;
0099   using iterator = InclusiveKinematicsMutableCollectionIterator;
0100
0101   InclusiveKinematicsCollection();
0102   InclusiveKinematicsCollection(InclusiveKinematicsCollectionData&& data, bool isSubsetColl);
0103   // This is a move-only type
0104   InclusiveKinematicsCollection(const InclusiveKinematicsCollection& ) = delete;
0105   InclusiveKinematicsCollection& operator=(const InclusiveKinematicsCollection& ) = delete;
0106   InclusiveKinematicsCollection(InclusiveKinematicsCollection&&) = default;
0107   InclusiveKinematicsCollection& operator=(InclusiveKinematicsCollection&&) = default;
0108
0109 //  InclusiveKinematicsCollection(InclusiveKinematicsVector* data, uint32_t collectionID);
0110   ~InclusiveKinematicsCollection();
0111
0112   constexpr static auto typeName = "edm4eic::InclusiveKinematicsCollection";
0113   constexpr static auto valueTypeName = "edm4eic::InclusiveKinematics";
0114   constexpr static auto dataTypeName = "edm4eic::InclusiveKinematicsData";
0115
0116   void clear() final;
0117
0118   /// Print this collection to the passed stream
0119   void print(std::ostream& os=std::cout, bool flush=true) const final;
0120
0121   /// operator to allow pointer like calling of members a la LCIO
0122   InclusiveKinematicsCollection* operator->() { return (InclusiveKinematicsCollection*) this; }
0123
0124   /// Append a new object to the collection, and return this object.
0125   MutableInclusiveKinematics create();
0126
0127   /// Append a new object to the collection, and return this object.
0128   /// Initialized with the parameters given
0129   template<typename... Args>
0130   MutableInclusiveKinematics create(Args&&... args);
0131
0132   /// number of elements in the collection
0133   std::size_t size() const final;
0134
0135   /// Is the collection empty
0136   bool empty() const final;
0137
0138   /// fully qualified type name
0139   const std::string_view getTypeName() const final { return typeName; }
0140   /// fully qualified type name of elements - with namespace
0141   const std::string_view getValueTypeName() const final { return valueTypeName; }
0142   /// fully qualified type name of stored POD elements - with namespace
0143   const std::string_view getDataTypeName() const final { return dataTypeName; }
0144   /// schema version
0145   podio::SchemaVersionT getSchemaVersion() const final;
0146
0147   bool isSubsetCollection() const final {
0148     return m_isSubsetColl;
0149   }
0150
0151   void setSubsetCollection(bool setSubset=true) final;
0152
0153   /// Returns the const object of given index
0154   InclusiveKinematics operator[](std::size_t index) const;
0155   /// Returns the object of a given index
0156   MutableInclusiveKinematics operator[](std::size_t index);
0157   /// Returns the const object of given index
0158   InclusiveKinematics at(std::size_t index) const;
0159   /// Returns the object of given index
0160   MutableInclusiveKinematics at(std::size_t index);
0161
0162
0163   /// Append object to the collection
0164   void push_back(MutableInclusiveKinematics object);
0165   /// Append an object to the (subset) collection
0166   void push_back(InclusiveKinematics object);
0167
0168   void prepareForWrite() const final;
0169   void prepareAfterRead() final;
0170   bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
0171
0172   /// Get the collection buffers for this collection
0173   podio::CollectionWriteBuffers getBuffers() final;
0174
0175   void setID(uint32_t ID) final {
0176     m_collectionID = ID;
0177     if (!m_isSubsetColl) {
0178       std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
0179                   [ID] (InclusiveKinematicsObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
0180       );
0181     }
0182     m_isValid = true;
0183   };
0184
0185   uint32_t getID() const final {
0186     return m_collectionID;
0187   }
0188
0189   bool isValid() const final {
0190     return m_isValid;
0191   }
0192
0193   size_t getDatamodelRegistryIndex() const final;
0194
0195   // support for the iterator protocol
0196   iterator begin() {
0197     return iterator(0, &m_storage.entries);
0198   }
0199   const_iterator begin() const {
0200     return const_iterator(0, &m_storage.entries);
0201   }
0202   iterator end() {
0203     return iterator(m_storage.entries.size(), &m_storage.entries);
0204   }
0205   const_iterator end() const {
0206     return const_iterator(m_storage.entries.size(), &m_storage.entries);
0207   }
0208
0209   std::vector<float> x(const size_t nElem = 0) const;
0210   std::vector<float> Q2(const size_t nElem = 0) const;
0211   std::vector<float> W(const size_t nElem = 0) const;
0212   std::vector<float> y(const size_t nElem = 0) const;
0213   std::vector<float> nu(const size_t nElem = 0) const;
0214
0215 private:
0216   // For setReferences, we need to give our own CollectionData access to our
0217   // private entries. Otherwise we would need to expose a public member function
0218   // that gives access to the Obj* which is definitely not what we want
0219   friend class InclusiveKinematicsCollectionData;
0220
0221   bool m_isValid{false};
0222   mutable bool m_isPrepared{false};
0223   bool m_isSubsetColl{false};
0224   uint32_t m_collectionID{0};
0225   mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
0226   mutable InclusiveKinematicsCollectionData m_storage{};
0227 };
0228
0229 std::ostream& operator<<(std::ostream& o, const InclusiveKinematicsCollection& v);
0230
0231 template<typename... Args>
0232 MutableInclusiveKinematics InclusiveKinematicsCollection::create(Args&&... args) {
0233   if (m_isSubsetColl) {
0234     throw std::logic_error("Cannot create new elements on a subset collection");
0235   }
0236   const int size = m_storage.entries.size();
0237   auto obj = new InclusiveKinematicsObj({size, m_collectionID}, {std::forward<Args>(args)...});
0238   m_storage.entries.push_back(obj);
0239
0240   return MutableInclusiveKinematics(podio::utils::MaybeSharedPtr(obj));
0241 }
0242
0243 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0244 void to_json(nlohmann::json& j, const InclusiveKinematicsCollection& collection);
0245 #endif
0246
0247 } // namespace edm4eic
0248
0249
0250 #endif