include/edm4hep/GeneratorEventParametersCollection.h

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