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();
0045
0046   /// Constructor initializing all members
0047   MutableEventHeader(std::int32_t eventNumber, std::int32_t runNumber, std::uint64_t timeStamp, double weight);
0048
0049   /// copy constructor
0050   MutableEventHeader(const MutableEventHeader& other) = default;
0051
0052   /// copy-assignment operator
0053   MutableEventHeader& operator=(MutableEventHeader other);
0054
0055   /// create a mutable deep-copy of the object with identical relations
0056   /// if cloneRelations=false, the relations are not cloned and will be empty
0057   MutableEventHeader clone(bool cloneRelations = true) const;
0058
0059   /// destructor
0060   ~MutableEventHeader() = default;
0061
0062 public:
0063   /// Access the event number
0064   std::int32_t getEventNumber() const;
0065
0066   /// Access the run number
0067   std::int32_t getRunNumber() const;
0068
0069   /// Access the time stamp
0070   std::uint64_t getTimeStamp() const;
0071
0072   /// Access the event weight
0073   double getWeight() const;
0074
0075   /// Set the event number
0076   void setEventNumber(std::int32_t value);
0077   /// Get mutable reference to event number
0078   std::int32_t& getEventNumber();
0079   /// Get reference to event number
0080   [[deprecated("use getEventNumber instead")]] std::int32_t& eventNumber();
0081
0082   /// Set the run number
0083   void setRunNumber(std::int32_t value);
0084   /// Get mutable reference to run number
0085   std::int32_t& getRunNumber();
0086   /// Get reference to run number
0087   [[deprecated("use getRunNumber instead")]] std::int32_t& runNumber();
0088
0089   /// Set the time stamp
0090   void setTimeStamp(std::uint64_t value);
0091   /// Get mutable reference to time stamp
0092   std::uint64_t& getTimeStamp();
0093   /// Get reference to time stamp
0094   [[deprecated("use getTimeStamp instead")]] std::uint64_t& timeStamp();
0095
0096   /// Set the event weight
0097   void setWeight(double value);
0098   /// Get mutable reference to event weight
0099   double& getWeight();
0100   /// Get reference to event weight
0101   [[deprecated("use getWeight instead")]] double& weight();
0102
0103   void addToWeights(const double&);
0104   std::size_t weights_size() const;
0105   double getWeights(std::size_t) const;
0106   std::vector<double>::const_iterator weights_begin() const;
0107   std::vector<double>::const_iterator weights_end() const;
0108   podio::RelationRange<double> getWeights() const;
0109
0110   /// check whether the object is actually available
0111   bool isAvailable() const;
0112   /// disconnect from EventHeaderObj instance
0113   void unlink() {
0114     m_obj = podio::utils::MaybeSharedPtr<EventHeaderObj>{nullptr};
0115   }
0116
0117   bool operator==(const MutableEventHeader& other) const {
0118     return m_obj == other.m_obj;
0119   }
0120   bool operator==(const EventHeader& other) const;
0121
0122   bool operator!=(const MutableEventHeader& other) const {
0123     return !(*this == other);
0124   }
0125   bool operator!=(const EventHeader& other) const {
0126     return !(*this == other);
0127   }
0128
0129   // less comparison operator, so that objects can be e.g. stored in sets.
0130   bool operator<(const MutableEventHeader& other) const {
0131     return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other);
0132   }
0133
0134   podio::ObjectID id() const {
0135     return getObjectID();
0136   }
0137
0138   const podio::ObjectID getObjectID() const;
0139
0140   friend void swap(MutableEventHeader& a, MutableEventHeader& b) {
0141     using std::swap;
0142     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0143   }
0144
0145 private:
0146   /// constructor from existing EventHeaderObj
0147   explicit MutableEventHeader(podio::utils::MaybeSharedPtr<EventHeaderObj> obj);
0148
0149   podio::utils::MaybeSharedPtr<EventHeaderObj> m_obj{nullptr};
0150 };
0151
0152 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0153 void to_json(nlohmann::json& j, const MutableEventHeader& value);
0154 #endif
0155
0156 } // namespace edm4hep
0157
0158 #endif