include/edm4eic/TrackCollection.h

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