examples/PodioDatamodel/ExampleClusterCollection.h

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