include/edm4hep/MutableEventHeader.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4HEP_MutableEventHeader_H
0004 #define EDM4HEP_MutableEventHeader_H
0005
0006 #include "edm4hep/EventHeaderObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4hep/EventHeader.h"
0009
0010 #include "podio/RelationRange.h"
0011 #include <cstdint>
0012 #include <vector>
0013
0014 #include "podio/utilities/MaybeSharedPtr.h"
0015
0016 #include <cstdint>
0017
0018 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0019 #include "nlohmann/json_fwd.hpp"
0020 #endif
0021
0022 // forward declarations
0023 namespace edm4hep {
0024 class EventHeaderCollection;
0025 }
0026
0027 namespace edm4hep {
0028
0029 /** @class MutableEventHeader
0030  *  Event Header. Additional parameters are assumed to go into the metadata tree.
0031  *  @author: EDM4hep authors
0032  */
0033 class MutableEventHeader {
0034
0035   friend class EventHeaderCollection;
0036   friend class EventHeaderMutableCollectionIterator;
0037   friend class EventHeader;
0038
0039 public:
0040   using object_type = EventHeader;
0041   using collection_type = EventHeaderCollection;
0042
0043   /// default constructor
0044   MutableEventHeader() = default;
0045
0046   /// Constructor initializing all members
0047   MutableEventHeader(const std::uint64_t eventNumber, const std::uint32_t runNumber, const std::uint64_t timeStamp,
0048                      const double weight);
0049
0050   /// copy constructor
0051   MutableEventHeader(const MutableEventHeader& other) = default;
0052
0053   /// copy-assignment operator
0054   MutableEventHeader& operator=(MutableEventHeader other) &; // Rebind this to other's internal object
0055   MutableEventHeader&
0056   operator=(MutableEventHeader other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
0057
0058   /// create a mutable deep-copy of the object with identical relations
0059   /// if cloneRelations=false, the relations are not cloned and will be empty
0060   MutableEventHeader clone(bool cloneRelations = true) const;
0061
0062   /// destructor
0063   ~MutableEventHeader() = default;
0064
0065 public:
0066   /// Access the event number
0067   std::uint64_t getEventNumber() const;
0068
0069   /// Access the run number
0070   std::uint32_t getRunNumber() const;
0071
0072   /// Access the time stamp
0073   std::uint64_t getTimeStamp() const;
0074
0075   /// Access the event weight
0076   double getWeight() const;
0077
0078   /// Set the event number
0079   void setEventNumber(const std::uint64_t eventNumber);
0080   /// Get mutable reference to event number
0081   std::uint64_t& getEventNumber();
0082   /// Get reference to event number
0083   [[deprecated("use getEventNumber instead")]] std::uint64_t& eventNumber();
0084
0085   /// Set the run number
0086   void setRunNumber(const std::uint32_t runNumber);
0087   /// Get mutable reference to run number
0088   std::uint32_t& getRunNumber();
0089   /// Get reference to run number
0090   [[deprecated("use getRunNumber instead")]] std::uint32_t& runNumber();
0091
0092   /// Set the time stamp
0093   void setTimeStamp(const std::uint64_t timeStamp);
0094   /// Get mutable reference to time stamp
0095   std::uint64_t& getTimeStamp();
0096   /// Get reference to time stamp
0097   [[deprecated("use getTimeStamp instead")]] std::uint64_t& timeStamp();
0098
0099   /// Set the event weight
0100   void setWeight(const double weight);
0101   /// Get mutable reference to event weight
0102   double& getWeight();
0103   /// Get reference to event weight
0104   [[deprecated("use getWeight instead")]] double& weight();
0105
0106   void addToWeights(const double&);
0107   std::size_t weights_size() const;
0108   double getWeights(std::size_t) const;
0109   std::vector<double>::const_iterator weights_begin() const;
0110   std::vector<double>::const_iterator weights_end() const;
0111   podio::RelationRange<double> getWeights() const;
0112
0113   /// check whether the object is actually available
0114   bool isAvailable() const;
0115   /// disconnect from EventHeaderObj instance
0116   void unlink() { m_obj = podio::utils::MaybeSharedPtr<EventHeaderObj>{nullptr}; }
0117
0118   bool operator==(const MutableEventHeader& other) const { return m_obj == other.m_obj; }
0119   bool operator==(const EventHeader& other) const;
0120
0121   bool operator!=(const MutableEventHeader& other) const { return !(*this == other); }
0122   bool operator!=(const EventHeader& other) const { return !(*this == other); }
0123
0124   // less comparison operator, so that objects can be e.g. stored in sets.
0125   bool operator<(const MutableEventHeader& other) const {
0126     return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other);
0127   }
0128
0129   podio::ObjectID id() const { return getObjectID(); }
0130
0131   const podio::ObjectID getObjectID() const;
0132
0133   friend std::hash<MutableEventHeader>;
0134
0135   friend void swap(MutableEventHeader& a, MutableEventHeader& b) {
0136     using std::swap;
0137     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0138   }
0139
0140 private:
0141   /// constructor from existing EventHeaderObj
0142   explicit MutableEventHeader(podio::utils::MaybeSharedPtr<EventHeaderObj> obj);
0143
0144   podio::utils::MaybeSharedPtr<EventHeaderObj> m_obj{new EventHeaderObj{}, podio::utils::MarkOwned};
0145 };
0146
0147 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0148 void to_json(nlohmann::json& j, const MutableEventHeader& value);
0149 #endif
0150
0151 } // namespace edm4hep
0152
0153 template <>
0154 struct std::hash<edm4hep::MutableEventHeader> {
0155   std::size_t operator()(const edm4hep::MutableEventHeader& obj) const {
0156     return std::hash<edm4hep::EventHeaderObj*>{}(obj.m_obj.get());
0157   }
0158 };
0159
0160 #endif