include/edm4hep/ClusterCollection.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4HEP_ClusterCollection_H
0004 #define EDM4HEP_ClusterCollection_H
0005
0006 // datamodel specific includes
0007 #include "edm4hep/Cluster.h"
0008 #include "edm4hep/MutableCluster.h"
0009 #include "edm4hep/ClusterObj.h"
0010 #include "edm4hep/ClusterCollectionData.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 <algorithm>
0023 #include <ostream>
0024 #include <mutex>
0025 #include <memory>
0026 #include <cstddef>
0027
0028 namespace podio {
0029   struct RelationNames;
0030 }
0031
0032 namespace edm4hep {
0033
0034
0035
0036 class ClusterCollectionIterator {
0037 public:
0038   using value_type = Cluster;
0039   using difference_type = ptrdiff_t;
0040   using reference = Cluster;
0041   using pointer = Cluster*;
0042   using iterator_category = std::input_iterator_tag;
0043   // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
0044   // remain valid as long as the iterator is valid, not as long as the range is valid.
0045   using iterator_concept = std::random_access_iterator_tag;
0046
0047   ClusterCollectionIterator(size_t index, const ClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ClusterObj>{nullptr}), m_collection(collection) {}
0048   ClusterCollectionIterator() = default;
0049
0050   ClusterCollectionIterator(const ClusterCollectionIterator&) = default;
0051   ClusterCollectionIterator(ClusterCollectionIterator&&) = default;
0052   ClusterCollectionIterator& operator=(const ClusterCollectionIterator&) = default;
0053   ClusterCollectionIterator& operator=(ClusterCollectionIterator&&) = default;
0054   ~ClusterCollectionIterator() = default;
0055
0056   auto operator<=>(const ClusterCollectionIterator& other) const {
0057     return m_index <=> other.m_index;
0058   }
0059
0060   bool operator==(const ClusterCollectionIterator& x) const {
0061     return m_index ==  x.m_index;
0062   }
0063
0064   reference operator*() const;
0065   pointer operator->();
0066   ClusterCollectionIterator& operator++();
0067   ClusterCollectionIterator operator++(int);
0068   ClusterCollectionIterator& operator--();
0069   ClusterCollectionIterator operator--(int);
0070   ClusterCollectionIterator& operator+=(difference_type n);
0071   ClusterCollectionIterator operator+(difference_type n) const;
0072   friend ClusterCollectionIterator operator+(difference_type n, const ClusterCollectionIterator& it);
0073   ClusterCollectionIterator& operator-=(difference_type n);
0074   ClusterCollectionIterator operator-(difference_type n) const;
0075   reference operator[](difference_type n) const;
0076   difference_type operator-(const ClusterCollectionIterator& other) const;
0077
0078 private:
0079   size_t m_index{0};
0080   Cluster m_object { podio::utils::MaybeSharedPtr<ClusterObj>{nullptr} };
0081   const ClusterObjPointerContainer* m_collection{nullptr};
0082 };
0083
0084
0085 class ClusterMutableCollectionIterator {
0086 public:
0087   using value_type = Cluster;
0088   using difference_type = ptrdiff_t;
0089   using reference = MutableCluster;
0090   using pointer = MutableCluster*;
0091   using iterator_category = std::input_iterator_tag;
0092   // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
0093   // remain valid as long as the iterator is valid, not as long as the range is valid.
0094   using iterator_concept = std::random_access_iterator_tag;
0095
0096   ClusterMutableCollectionIterator(size_t index, const ClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ClusterObj>{nullptr}), m_collection(collection) {}
0097   ClusterMutableCollectionIterator() = default;
0098
0099   ClusterMutableCollectionIterator(const ClusterMutableCollectionIterator&) = default;
0100   ClusterMutableCollectionIterator(ClusterMutableCollectionIterator&&) = default;
0101   ClusterMutableCollectionIterator& operator=(const ClusterMutableCollectionIterator&) = default;
0102   ClusterMutableCollectionIterator& operator=(ClusterMutableCollectionIterator&&) = default;
0103   ~ClusterMutableCollectionIterator() = default;
0104
0105   auto operator<=>(const ClusterMutableCollectionIterator& other) const {
0106     return m_index <=> other.m_index;
0107   }
0108
0109   bool operator==(const ClusterMutableCollectionIterator& x) const {
0110     return m_index ==  x.m_index;
0111   }
0112
0113   reference operator*() const;
0114   pointer operator->();
0115   ClusterMutableCollectionIterator& operator++();
0116   ClusterMutableCollectionIterator operator++(int);
0117   ClusterMutableCollectionIterator& operator--();
0118   ClusterMutableCollectionIterator operator--(int);
0119   ClusterMutableCollectionIterator& operator+=(difference_type n);
0120   ClusterMutableCollectionIterator operator+(difference_type n) const;
0121   friend ClusterMutableCollectionIterator operator+(difference_type n, const ClusterMutableCollectionIterator& it);
0122   ClusterMutableCollectionIterator& operator-=(difference_type n);
0123   ClusterMutableCollectionIterator operator-(difference_type n) const;
0124   reference operator[](difference_type n) const;
0125   difference_type operator-(const ClusterMutableCollectionIterator& other) const;
0126
0127 private:
0128   size_t m_index{0};
0129   MutableCluster m_object { podio::utils::MaybeSharedPtr<ClusterObj>{nullptr} };
0130   const ClusterObjPointerContainer* m_collection{nullptr};
0131 };
0132
0133
0134 /**
0135 A Collection is identified by an ID.
0136 */
0137 class ClusterCollection : public podio::CollectionBase {
0138 public:
0139   using value_type = Cluster;
0140   using mutable_type = MutableCluster;
0141   using const_iterator = ClusterCollectionIterator;
0142   using iterator = ClusterMutableCollectionIterator;
0143   using difference_type = ptrdiff_t;
0144   using size_type = size_t;
0145   using const_reverse_iterator = std::reverse_iterator<const_iterator>;
0146   using reverse_iterator = std::reverse_iterator<iterator>;
0147
0148   ClusterCollection();
0149   ClusterCollection(ClusterCollectionData&& data, bool isSubsetColl);
0150   // This is a move-only type
0151   ClusterCollection(const ClusterCollection& ) = delete;
0152   ClusterCollection& operator=(const ClusterCollection& ) = delete;
0153   ClusterCollection(ClusterCollection&&) = default;
0154   ClusterCollection& operator=(ClusterCollection&&) = default;
0155
0156 //  ClusterCollection(ClusterVector* data, uint32_t collectionID);
0157   ~ClusterCollection() override;
0158
0159   constexpr static std::string_view typeName = "edm4hep::ClusterCollection";
0160   constexpr static std::string_view valueTypeName = "edm4hep::Cluster";
0161   constexpr static std::string_view dataTypeName = "edm4hep::ClusterData";
0162
0163   void clear() final;
0164
0165   /// Print this collection to the passed stream
0166   void print(std::ostream& os=std::cout, bool flush=true) const final;
0167
0168   /// operator to allow pointer like calling of members a la LCIO
0169   ClusterCollection* operator->() { return static_cast<ClusterCollection*>(this); }
0170
0171   /// Append a new object to the collection, and return this object.
0172   MutableCluster create();
0173
0174   /// Append a new object to the collection, and return this object.
0175   /// Initialized with the parameters given
0176   template<typename... Args>
0177   MutableCluster create(Args&&... args);
0178
0179   /// number of elements in the collection
0180   std::size_t size() const final;
0181
0182   /// maximal number of elements in the collection
0183   std::size_t max_size() const final;
0184
0185   /// Is the collection empty
0186   bool empty() const final;
0187
0188   /// fully qualified type name
0189   const std::string_view getTypeName() const final { return typeName; }
0190   /// fully qualified type name of elements - with namespace
0191   const std::string_view getValueTypeName() const final { return valueTypeName; }
0192   /// fully qualified type name of stored POD elements - with namespace
0193   const std::string_view getDataTypeName() const final { return dataTypeName; }
0194   /// schema version
0195   podio::SchemaVersionT getSchemaVersion() const final;
0196
0197   bool isSubsetCollection() const final {
0198     return m_isSubsetColl;
0199   }
0200
0201   void setSubsetCollection(bool setSubset=true) final;
0202
0203   /// Returns the const object of given index
0204   Cluster operator[](std::size_t index) const;
0205   /// Returns the object of a given index
0206   MutableCluster operator[](std::size_t index);
0207   /// Returns the const object of given index
0208   Cluster at(std::size_t index) const;
0209   /// Returns the object of given index
0210   MutableCluster at(std::size_t index);
0211
0212
0213   /// Append object to the collection
0214   void push_back(const MutableCluster& object);
0215   /// Append an object to the (subset) collection
0216   void push_back(const Cluster& object);
0217
0218   void prepareForWrite() const final;
0219   void prepareAfterRead() final;
0220   bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
0221
0222   /// Get the collection buffers for this collection
0223   podio::CollectionWriteBuffers getBuffers() final;
0224
0225   void setID(uint32_t ID) final {
0226     m_collectionID = ID;
0227     if (!m_isSubsetColl) {
0228       std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
0229                   [ID] (ClusterObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
0230       );
0231     }
0232     m_isValid = true;
0233   }
0234
0235   uint32_t getID() const final {
0236     return m_collectionID;
0237   }
0238
0239   bool isValid() const final {
0240     return m_isValid;
0241   }
0242
0243   size_t getDatamodelRegistryIndex() const final;
0244
0245   // support for the iterator protocol
0246   iterator begin() {
0247     return iterator(0, &m_storage.entries);
0248   }
0249   const_iterator begin() const {
0250     return const_iterator(0, &m_storage.entries);
0251   }
0252   const_iterator cbegin() const {
0253     return begin();
0254   }
0255   iterator end() {
0256     return iterator(m_storage.entries.size(), &m_storage.entries);
0257   }
0258   const_iterator end() const {
0259     return const_iterator(m_storage.entries.size(), &m_storage.entries);
0260   }
0261   const_iterator cend() const {
0262     return end();
0263   }
0264   // reverse iterators
0265   reverse_iterator rbegin() {
0266     return reverse_iterator(end());
0267   }
0268   const_reverse_iterator rbegin() const {
0269     return const_reverse_iterator(end());
0270   }
0271   const_reverse_iterator crbegin() const {
0272     return rbegin();
0273   }
0274   reverse_iterator rend() {
0275     return reverse_iterator(begin());
0276   }
0277   const_reverse_iterator rend() const {
0278     return const_reverse_iterator(begin());
0279   }
0280   const_reverse_iterator crend() const {
0281     return rend();
0282   }
0283
0284
0285   std::vector<std::int32_t> type(const size_t nElem = 0) const;
0286   std::vector<float> energy(const size_t nElem = 0) const;
0287   std::vector<float> energyError(const size_t nElem = 0) const;
0288   std::vector<edm4hep::Vector3f> position(const size_t nElem = 0) const;
0289   std::vector<edm4hep::CovMatrix3f> positionError(const size_t nElem = 0) const;
0290   std::vector<float> iTheta(const size_t nElem = 0) const;
0291   std::vector<float> phi(const size_t nElem = 0) const;
0292   std::vector<edm4hep::Vector3f> directionError(const size_t nElem = 0) const;
0293
0294 private:
0295   // For setReferences, we need to give our own CollectionData access to our
0296   // private entries. Otherwise we would need to expose a public member function
0297   // that gives access to the Obj* which is definitely not what we want
0298   friend class ClusterCollectionData;
0299
0300   bool m_isValid{false};
0301   mutable bool m_isPrepared{false};
0302   bool m_isSubsetColl{false};
0303   uint32_t m_collectionID{0};
0304   mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
0305   mutable ClusterCollectionData m_storage{};
0306 };
0307
0308 std::ostream& operator<<(std::ostream& o, const ClusterCollection& v);
0309
0310 template<typename... Args>
0311 MutableCluster ClusterCollection::create(Args&&... args) {
0312   if (m_isSubsetColl) {
0313     throw std::logic_error("Cannot create new elements on a subset collection");
0314   }
0315   const int size = m_storage.entries.size();
0316   auto obj = new ClusterObj({size, m_collectionID}, {std::forward<Args>(args)...});
0317   m_storage.entries.push_back(obj);
0318
0319   // Need to initialize the relation vectors manually for the {ObjectID, ClusterData} constructor
0320   obj->m_clusters = new std::vector<edm4hep::Cluster>();
0321   obj->m_hits = new std::vector<edm4hep::CalorimeterHit>();
0322   obj->m_shapeParameters = new std::vector<float>();
0323   obj->m_subdetectorEnergies = new std::vector<float>();
0324   m_storage.createRelations(obj);
0325   return MutableCluster(podio::utils::MaybeSharedPtr(obj));
0326 }
0327
0328 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0329 void to_json(nlohmann::json& j, const ClusterCollection& collection);
0330 #endif
0331
0332 } // namespace edm4hep
0333
0334
0335 #endif