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
0028 namespace edm4hep {
0029
0030
0031 /** @class MutableEventHeader
0032  *  Event Header. Additional parameters are assumed to go into the metadata tree.
0033  *  @author: EDM4hep authors
0034  */
0035 class MutableEventHeader {
0036
0037   friend class EventHeaderCollection;
0038   friend class EventHeaderMutableCollectionIterator;
0039   friend class EventHeader;
0040
0041 public:
0042   using object_type = EventHeader;
0043   using collection_type = EventHeaderCollection;
0044
0045   /// default constructor
0046   MutableEventHeader();
0047
0048   /// Constructor initializing all members
0049   MutableEventHeader(const std::int32_t eventNumber, const std::int32_t runNumber, const std::uint64_t timeStamp, const double weight);
0050
0051   /// copy constructor
0052   MutableEventHeader(const MutableEventHeader& other) = default;
0053
0054   /// copy-assignment operator
0055   MutableEventHeader& operator=(MutableEventHeader other) &; // Rebind this to other's internal object
0056   MutableEventHeader& 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
0066 public:
0067
0068   /// Access the event number
0069   std::int32_t getEventNumber() const;
0070
0071   /// Access the run number
0072   std::int32_t getRunNumber() const;
0073
0074   /// Access the time stamp
0075   std::uint64_t getTimeStamp() const;
0076
0077   /// Access the event weight
0078   double getWeight() const;
0079
0080
0081
0082   /// Set the event number
0083   void setEventNumber(const std::int32_t eventNumber);
0084   /// Get mutable reference to event number
0085   std::int32_t& getEventNumber();
0086   /// Get reference to event number
0087   [[deprecated("use getEventNumber instead")]]
0088   std::int32_t& eventNumber();
0089
0090   /// Set the run number
0091   void setRunNumber(const std::int32_t runNumber);
0092   /// Get mutable reference to run number
0093   std::int32_t& getRunNumber();
0094   /// Get reference to run number
0095   [[deprecated("use getRunNumber instead")]]
0096   std::int32_t& runNumber();
0097
0098   /// Set the time stamp
0099   void setTimeStamp(const std::uint64_t timeStamp);
0100   /// Get mutable reference to time stamp
0101   std::uint64_t& getTimeStamp();
0102   /// Get reference to time stamp
0103   [[deprecated("use getTimeStamp instead")]]
0104   std::uint64_t& timeStamp();
0105
0106   /// Set the event weight
0107   void setWeight(const double weight);
0108   /// Get mutable reference to event weight
0109   double& getWeight();
0110   /// Get reference to event weight
0111   [[deprecated("use getWeight instead")]]
0112   double& weight();
0113
0114
0115
0116   void addToWeights(const double&);
0117   std::size_t weights_size() const;
0118   double getWeights(std::size_t) const;
0119   std::vector<double>::const_iterator weights_begin() const;
0120   std::vector<double>::const_iterator weights_end() const;
0121   podio::RelationRange<double> getWeights() const;
0122
0123
0124
0125   /// check whether the object is actually available
0126   bool isAvailable() const;
0127   /// disconnect from EventHeaderObj instance
0128   void unlink() { m_obj = podio::utils::MaybeSharedPtr<EventHeaderObj>{nullptr}; }
0129
0130   bool operator==(const MutableEventHeader& other) const { return m_obj == other.m_obj; }
0131   bool operator==(const EventHeader& other) const;
0132
0133   bool operator!=(const MutableEventHeader& other) const { return !(*this == other); }
0134   bool operator!=(const EventHeader& other) const { return !(*this == other); }
0135
0136   // less comparison operator, so that objects can be e.g. stored in sets.
0137   bool operator<(const MutableEventHeader& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0138
0139   podio::ObjectID id() const { return getObjectID(); }
0140
0141   const podio::ObjectID getObjectID() const;
0142
0143   friend std::hash<MutableEventHeader>;
0144
0145   friend void swap(MutableEventHeader& a, MutableEventHeader& b) {
0146     using std::swap;
0147     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0148   }
0149
0150 private:
0151   /// constructor from existing EventHeaderObj
0152   explicit MutableEventHeader(podio::utils::MaybeSharedPtr<EventHeaderObj> obj);
0153
0154   podio::utils::MaybeSharedPtr<EventHeaderObj> m_obj{nullptr};
0155 };
0156
0157 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0158 void to_json(nlohmann::json& j, const MutableEventHeader& value);
0159 #endif
0160
0161
0162 } // namespace edm4hep
0163
0164
0165
0166 template<>
0167 struct std::hash<edm4hep::MutableEventHeader> {
0168   std::size_t operator()(const edm4hep::MutableEventHeader& obj) const {
0169     return std::hash<edm4hep::EventHeaderObj*>{}(obj.m_obj.get());
0170   }
0171 };
0172
0173
0174 #endif