include/edm4eic/ProtoClusterCollection.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_ProtoClusterCollection_H
0004 #define EDM4EIC_ProtoClusterCollection_H
0005
0006 // datamodel specific includes
0007 #include "edm4eic/ProtoClusterData.h"
0008 #include "edm4eic/ProtoCluster.h"
0009 #include "edm4eic/MutableProtoCluster.h"
0010 #include "edm4eic/ProtoClusterObj.h"
0011 #include "edm4eic/ProtoClusterCollectionData.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 ProtoClusterCollectionIterator {
0041 public:
0042   ProtoClusterCollectionIterator(size_t index, const ProtoClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ProtoClusterObj>{nullptr}), m_collection(collection) {}
0043
0044   ProtoClusterCollectionIterator(const ProtoClusterCollectionIterator&) = delete;
0045   ProtoClusterCollectionIterator& operator=(const ProtoClusterCollectionIterator&) = delete;
0046
0047   bool operator!=(const ProtoClusterCollectionIterator& x) const {
0048     return m_index != x.m_index; // TODO: may not be complete
0049   }
0050
0051   bool operator==(const ProtoClusterCollectionIterator& x) const {
0052     return m_index ==  x.m_index; // TODO: may not be complete
0053   }
0054
0055   ProtoCluster operator*();
0056   ProtoCluster* operator->();
0057   ProtoClusterCollectionIterator& operator++();
0058
0059 private:
0060   size_t m_index;
0061   ProtoCluster m_object;
0062   const ProtoClusterObjPointerContainer* m_collection;
0063 };
0064
0065
0066 class ProtoClusterMutableCollectionIterator {
0067 public:
0068   ProtoClusterMutableCollectionIterator(size_t index, const ProtoClusterObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<ProtoClusterObj>{nullptr}), m_collection(collection) {}
0069
0070   ProtoClusterMutableCollectionIterator(const ProtoClusterMutableCollectionIterator&) = delete;
0071   ProtoClusterMutableCollectionIterator& operator=(const ProtoClusterMutableCollectionIterator&) = delete;
0072
0073   bool operator!=(const ProtoClusterMutableCollectionIterator& x) const {
0074     return m_index != x.m_index; // TODO: may not be complete
0075   }
0076
0077   bool operator==(const ProtoClusterMutableCollectionIterator& x) const {
0078     return m_index ==  x.m_index; // TODO: may not be complete
0079   }
0080
0081   MutableProtoCluster operator*();
0082   MutableProtoCluster* operator->();
0083   ProtoClusterMutableCollectionIterator& operator++();
0084
0085 private:
0086   size_t m_index;
0087   MutableProtoCluster m_object;
0088   const ProtoClusterObjPointerContainer* m_collection;
0089 };
0090
0091
0092 /**
0093 A Collection is identified by an ID.
0094 */
0095 class ProtoClusterCollection : public podio::CollectionBase {
0096 public:
0097   using value_type = ProtoCluster;
0098   using const_iterator = ProtoClusterCollectionIterator;
0099   using iterator = ProtoClusterMutableCollectionIterator;
0100
0101   ProtoClusterCollection();
0102   ProtoClusterCollection(ProtoClusterCollectionData&& data, bool isSubsetColl);
0103   // This is a move-only type
0104   ProtoClusterCollection(const ProtoClusterCollection& ) = delete;
0105   ProtoClusterCollection& operator=(const ProtoClusterCollection& ) = delete;
0106   ProtoClusterCollection(ProtoClusterCollection&&) = default;
0107   ProtoClusterCollection& operator=(ProtoClusterCollection&&) = default;
0108
0109 //  ProtoClusterCollection(ProtoClusterVector* data, uint32_t collectionID);
0110   ~ProtoClusterCollection();
0111
0112   constexpr static auto typeName = "edm4eic::ProtoClusterCollection";
0113   constexpr static auto valueTypeName = "edm4eic::ProtoCluster";
0114   constexpr static auto dataTypeName = "edm4eic::ProtoClusterData";
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   ProtoClusterCollection* operator->() { return (ProtoClusterCollection*) this; }
0123
0124   /// Append a new object to the collection, and return this object.
0125   MutableProtoCluster 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   MutableProtoCluster 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   ProtoCluster operator[](std::size_t index) const;
0155   /// Returns the object of a given index
0156   MutableProtoCluster operator[](std::size_t index);
0157   /// Returns the const object of given index
0158   ProtoCluster at(std::size_t index) const;
0159   /// Returns the object of given index
0160   MutableProtoCluster at(std::size_t index);
0161
0162
0163   /// Append object to the collection
0164   void push_back(MutableProtoCluster object);
0165   /// Append an object to the (subset) collection
0166   void push_back(ProtoCluster 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] (ProtoClusterObj* 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
0210 private:
0211   // For setReferences, we need to give our own CollectionData access to our
0212   // private entries. Otherwise we would need to expose a public member function
0213   // that gives access to the Obj* which is definitely not what we want
0214   friend class ProtoClusterCollectionData;
0215
0216   bool m_isValid{false};
0217   mutable bool m_isPrepared{false};
0218   bool m_isSubsetColl{false};
0219   uint32_t m_collectionID{0};
0220   mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
0221   mutable ProtoClusterCollectionData m_storage{};
0222 };
0223
0224 std::ostream& operator<<(std::ostream& o, const ProtoClusterCollection& v);
0225
0226 template<typename... Args>
0227 MutableProtoCluster ProtoClusterCollection::create(Args&&... args) {
0228   if (m_isSubsetColl) {
0229     throw std::logic_error("Cannot create new elements on a subset collection");
0230   }
0231   const int size = m_storage.entries.size();
0232   auto obj = new ProtoClusterObj({size, m_collectionID}, {std::forward<Args>(args)...});
0233   m_storage.entries.push_back(obj);
0234
0235   // Need to initialize the relation vectors manually for the {ObjectID, ProtoClusterData} constructor
0236   obj->m_hits = new std::vector<edm4eic::CalorimeterHit>();
0237   obj->m_weights = new std::vector<float>();
0238   m_storage.createRelations(obj);
0239   return MutableProtoCluster(podio::utils::MaybeSharedPtr(obj));
0240 }
0241
0242 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0243 void to_json(nlohmann::json& j, const ProtoClusterCollection& collection);
0244 #endif
0245
0246 } // namespace edm4eic
0247
0248
0249 #endif