include/edm4hep/TimeSeriesCollection.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4HEP_TimeSeriesCollection_H
0004 #define EDM4HEP_TimeSeriesCollection_H
0005
0006 // datamodel specific includes
0007 #include "edm4hep/MutableTimeSeries.h"
0008 #include "edm4hep/TimeSeries.h"
0009 #include "edm4hep/TimeSeriesCollectionData.h"
0010 #include "edm4hep/TimeSeriesObj.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 <array>
0022 #include <cstddef>
0023 #include <memory>
0024 #include <mutex>
0025 #include <ostream>
0026 #include <string_view>
0027 #include <vector>
0028
0029 namespace podio {
0030 struct RelationNames;
0031 }
0032
0033 namespace edm4hep {
0034
0035 class TimeSeriesCollectionIterator {
0036 public:
0037   TimeSeriesCollectionIterator(size_t index, const TimeSeriesObjPointerContainer* collection) :
0038       m_index(index), m_object(podio::utils::MaybeSharedPtr<TimeSeriesObj>{nullptr}), m_collection(collection) {
0039   }
0040
0041   TimeSeriesCollectionIterator(const TimeSeriesCollectionIterator&) = delete;
0042   TimeSeriesCollectionIterator& operator=(const TimeSeriesCollectionIterator&) = delete;
0043
0044   bool operator!=(const TimeSeriesCollectionIterator& x) const {
0045     return m_index != x.m_index; // TODO: may not be complete
0046   }
0047
0048   bool operator==(const TimeSeriesCollectionIterator& x) const {
0049     return m_index == x.m_index; // TODO: may not be complete
0050   }
0051
0052   TimeSeries operator*();
0053   TimeSeries* operator->();
0054   TimeSeriesCollectionIterator& operator++();
0055
0056 private:
0057   size_t m_index;
0058   TimeSeries m_object;
0059   const TimeSeriesObjPointerContainer* m_collection;
0060 };
0061
0062 class TimeSeriesMutableCollectionIterator {
0063 public:
0064   TimeSeriesMutableCollectionIterator(size_t index, const TimeSeriesObjPointerContainer* collection) :
0065       m_index(index), m_object(podio::utils::MaybeSharedPtr<TimeSeriesObj>{nullptr}), m_collection(collection) {
0066   }
0067
0068   TimeSeriesMutableCollectionIterator(const TimeSeriesMutableCollectionIterator&) = delete;
0069   TimeSeriesMutableCollectionIterator& operator=(const TimeSeriesMutableCollectionIterator&) = delete;
0070
0071   bool operator!=(const TimeSeriesMutableCollectionIterator& x) const {
0072     return m_index != x.m_index; // TODO: may not be complete
0073   }
0074
0075   bool operator==(const TimeSeriesMutableCollectionIterator& x) const {
0076     return m_index == x.m_index; // TODO: may not be complete
0077   }
0078
0079   MutableTimeSeries operator*();
0080   MutableTimeSeries* operator->();
0081   TimeSeriesMutableCollectionIterator& operator++();
0082
0083 private:
0084   size_t m_index;
0085   MutableTimeSeries m_object;
0086   const TimeSeriesObjPointerContainer* m_collection;
0087 };
0088
0089 /**
0090 A Collection is identified by an ID.
0091 */
0092 class TimeSeriesCollection : public podio::CollectionBase {
0093 public:
0094   using value_type = TimeSeries;
0095   using const_iterator = TimeSeriesCollectionIterator;
0096   using iterator = TimeSeriesMutableCollectionIterator;
0097   using difference_type = ptrdiff_t;
0098   using size_type = size_t;
0099
0100   TimeSeriesCollection();
0101   TimeSeriesCollection(TimeSeriesCollectionData&& data, bool isSubsetColl);
0102   // This is a move-only type
0103   TimeSeriesCollection(const TimeSeriesCollection&) = delete;
0104   TimeSeriesCollection& operator=(const TimeSeriesCollection&) = delete;
0105   TimeSeriesCollection(TimeSeriesCollection&&) = default;
0106   TimeSeriesCollection& operator=(TimeSeriesCollection&&) = default;
0107
0108   //  TimeSeriesCollection(TimeSeriesVector* data, uint32_t collectionID);
0109   ~TimeSeriesCollection();
0110
0111   constexpr static auto typeName = "edm4hep::TimeSeriesCollection";
0112   constexpr static auto valueTypeName = "edm4hep::TimeSeries";
0113   constexpr static auto dataTypeName = "edm4hep::TimeSeriesData";
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   TimeSeriesCollection* operator->() {
0122     return static_cast<TimeSeriesCollection*>(this);
0123   }
0124
0125   /// Append a new object to the collection, and return this object.
0126   MutableTimeSeries create();
0127
0128   /// Append a new object to the collection, and return this object.
0129   /// Initialized with the parameters given
0130   template <typename... Args>
0131   MutableTimeSeries create(Args&&... args);
0132
0133   /// number of elements in the collection
0134   std::size_t size() const final;
0135
0136   /// maximal number of elements in the collection
0137   std::size_t max_size() const final;
0138
0139   /// Is the collection empty
0140   bool empty() const final;
0141
0142   /// fully qualified type name
0143   const std::string_view getTypeName() const final {
0144     return typeName;
0145   }
0146   /// fully qualified type name of elements - with namespace
0147   const std::string_view getValueTypeName() const final {
0148     return valueTypeName;
0149   }
0150   /// fully qualified type name of stored POD elements - with namespace
0151   const std::string_view getDataTypeName() const final {
0152     return dataTypeName;
0153   }
0154   /// schema version
0155   podio::SchemaVersionT getSchemaVersion() const final;
0156
0157   bool isSubsetCollection() const final {
0158     return m_isSubsetColl;
0159   }
0160
0161   void setSubsetCollection(bool setSubset = true) final;
0162
0163   /// Returns the const object of given index
0164   TimeSeries operator[](std::size_t index) const;
0165   /// Returns the object of a given index
0166   MutableTimeSeries operator[](std::size_t index);
0167   /// Returns the const object of given index
0168   TimeSeries at(std::size_t index) const;
0169   /// Returns the object of given index
0170   MutableTimeSeries at(std::size_t index);
0171
0172   /// Append object to the collection
0173   void push_back(const MutableTimeSeries& object);
0174   /// Append an object to the (subset) collection
0175   void push_back(const TimeSeries& object);
0176
0177   void prepareForWrite() const final;
0178   void prepareAfterRead() final;
0179   bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
0180
0181   /// Get the collection buffers for this collection
0182   podio::CollectionWriteBuffers getBuffers() final;
0183
0184   void setID(uint32_t ID) final {
0185     m_collectionID = ID;
0186     if (!m_isSubsetColl) {
0187       std::for_each(m_storage.entries.begin(), m_storage.entries.end(), [ID](TimeSeriesObj* obj) {
0188         obj->id = {obj->id.index, static_cast<uint32_t>(ID)};
0189       });
0190     }
0191     m_isValid = true;
0192   }
0193
0194   uint32_t getID() const final {
0195     return m_collectionID;
0196   }
0197
0198   bool isValid() const final {
0199     return m_isValid;
0200   }
0201
0202   size_t getDatamodelRegistryIndex() const final;
0203
0204   // support for the iterator protocol
0205   iterator begin() {
0206     return iterator(0, &m_storage.entries);
0207   }
0208   const_iterator begin() const {
0209     return const_iterator(0, &m_storage.entries);
0210   }
0211   const_iterator cbegin() const {
0212     return begin();
0213   }
0214   iterator end() {
0215     return iterator(m_storage.entries.size(), &m_storage.entries);
0216   }
0217   const_iterator end() const {
0218     return const_iterator(m_storage.entries.size(), &m_storage.entries);
0219   }
0220   const_iterator cend() const {
0221     return end();
0222   }
0223
0224   std::vector<std::uint64_t> cellID(const size_t nElem = 0) const;
0225   std::vector<float> time(const size_t nElem = 0) const;
0226   std::vector<float> interval(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 TimeSeriesCollectionData;
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 TimeSeriesCollectionData m_storage{};
0240 };
0241
0242 std::ostream& operator<<(std::ostream& o, const TimeSeriesCollection& v);
0243
0244 template <typename... Args>
0245 MutableTimeSeries TimeSeriesCollection::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 TimeSeriesObj({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, TimeSeriesData} constructor
0254   obj->m_amplitude = new std::vector<float>();
0255   m_storage.createRelations(obj);
0256   return MutableTimeSeries(podio::utils::MaybeSharedPtr(obj));
0257 }
0258
0259 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0260 void to_json(nlohmann::json& j, const TimeSeriesCollection& collection);
0261 #endif
0262
0263 } // namespace edm4hep
0264
0265 #endif