include/edm4hep/MutableRecDqdx.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4HEP_MutableRecDqdx_H
0004 #define EDM4HEP_MutableRecDqdx_H
0005
0006 #include "edm4hep/RecDqdxObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4hep/RecDqdx.h"
0009
0010 #include "edm4hep/Quantity.h"
0011
0012 #include "podio/utilities/MaybeSharedPtr.h"
0013
0014 #include <cstdint>
0015
0016 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0017 #include "nlohmann/json_fwd.hpp"
0018 #endif
0019
0020 // forward declarations
0021 namespace edm4hep {
0022 class RecDqdxCollection;
0023 class Track;
0024 class MutableTrack;
0025 } // namespace edm4hep
0026
0027 namespace edm4hep {
0028
0029 /** @class MutableRecDqdx
0030  *  dN/dx or dE/dx info of a Track
0031  *  @author: EDM4hep authors
0032  */
0033 class MutableRecDqdx {
0034
0035   friend class RecDqdxCollection;
0036   friend class RecDqdxMutableCollectionIterator;
0037   friend class RecDqdx;
0038
0039 public:
0040   using object_type = RecDqdx;
0041   using collection_type = RecDqdxCollection;
0042
0043   /// default constructor
0044   MutableRecDqdx();
0045
0046   /// Constructor initializing all members
0047   MutableRecDqdx(edm4hep::Quantity dQdx);
0048
0049   /// copy constructor
0050   MutableRecDqdx(const MutableRecDqdx& other) = default;
0051
0052   /// copy-assignment operator
0053   MutableRecDqdx& operator=(MutableRecDqdx 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   MutableRecDqdx clone(bool cloneRelations = true) const;
0058
0059   /// destructor
0060   ~MutableRecDqdx() = default;
0061
0062 public:
0063   /// Access the the reconstructed dEdx or dNdx and its error
0064   const edm4hep::Quantity& getDQdx() const;
0065
0066   /// Access the the corresponding track
0067   const edm4hep::Track getTrack() const;
0068
0069   /// Set the the reconstructed dEdx or dNdx and its error
0070   void setDQdx(edm4hep::Quantity value);
0071   /// Get mutable reference to the reconstructed dEdx or dNdx and its error
0072   edm4hep::Quantity& getDQdx();
0073   /// Get reference to the reconstructed dEdx or dNdx and its error
0074   [[deprecated("use getDQdx instead")]] edm4hep::Quantity& dQdx();
0075
0076   /// Set the the corresponding track
0077   void setTrack(const edm4hep::Track& value);
0078
0079   /// check whether the object is actually available
0080   bool isAvailable() const;
0081   /// disconnect from RecDqdxObj instance
0082   void unlink() {
0083     m_obj = podio::utils::MaybeSharedPtr<RecDqdxObj>{nullptr};
0084   }
0085
0086   bool operator==(const MutableRecDqdx& other) const {
0087     return m_obj == other.m_obj;
0088   }
0089   bool operator==(const RecDqdx& other) const;
0090
0091   bool operator!=(const MutableRecDqdx& other) const {
0092     return !(*this == other);
0093   }
0094   bool operator!=(const RecDqdx& other) const {
0095     return !(*this == other);
0096   }
0097
0098   // less comparison operator, so that objects can be e.g. stored in sets.
0099   bool operator<(const MutableRecDqdx& other) const {
0100     return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other);
0101   }
0102
0103   podio::ObjectID id() const {
0104     return getObjectID();
0105   }
0106
0107   const podio::ObjectID getObjectID() const;
0108
0109   friend void swap(MutableRecDqdx& a, MutableRecDqdx& b) {
0110     using std::swap;
0111     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0112   }
0113
0114 private:
0115   /// constructor from existing RecDqdxObj
0116   explicit MutableRecDqdx(podio::utils::MaybeSharedPtr<RecDqdxObj> obj);
0117
0118   podio::utils::MaybeSharedPtr<RecDqdxObj> m_obj{nullptr};
0119 };
0120
0121 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0122 void to_json(nlohmann::json& j, const MutableRecDqdx& value);
0123 #endif
0124
0125 } // namespace edm4hep
0126
0127 #endif