include/edm4eic/MutableMCRecoTrackerHitAssociation.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_MutableMCRecoTrackerHitAssociation_H
0004 #define EDM4EIC_MutableMCRecoTrackerHitAssociation_H
0005
0006 #include "edm4eic/MCRecoTrackerHitAssociationObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4eic/MCRecoTrackerHitAssociation.h"
0009
0010
0011 #include "podio/utilities/MaybeSharedPtr.h"
0012
0013 #include <cstdint>
0014
0015 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0016 #include "nlohmann/json_fwd.hpp"
0017 #endif
0018
0019 // forward declarations
0020 namespace edm4eic {
0021 class MCRecoTrackerHitAssociationCollection;
0022 class RawTrackerHit;
0023 class MutableRawTrackerHit;
0024 }
0025 namespace edm4hep {
0026 class SimTrackerHit;
0027 class MutableSimTrackerHit;
0028 }
0029
0030
0031 namespace edm4eic {
0032
0033
0034 /** @class MutableMCRecoTrackerHitAssociation
0035  *  Association between a RawTrackerHit and a SimTrackerHit
0036  *  @author: C. Dilks, W. Deconinck
0037  */
0038 class MutableMCRecoTrackerHitAssociation {
0039
0040   friend class MCRecoTrackerHitAssociationCollection;
0041   friend class MCRecoTrackerHitAssociationMutableCollectionIterator;
0042   friend class MCRecoTrackerHitAssociation;
0043
0044 public:
0045   using object_type = MCRecoTrackerHitAssociation;
0046   using collection_type = MCRecoTrackerHitAssociationCollection;
0047
0048   /// default constructor
0049   MutableMCRecoTrackerHitAssociation();
0050
0051   /// Constructor initializing all members
0052   MutableMCRecoTrackerHitAssociation(float weight);
0053
0054   /// copy constructor
0055   MutableMCRecoTrackerHitAssociation(const MutableMCRecoTrackerHitAssociation& other) = default;
0056
0057   /// copy-assignment operator
0058   MutableMCRecoTrackerHitAssociation& operator=(MutableMCRecoTrackerHitAssociation other);
0059
0060   /// create a mutable deep-copy of the object with identical relations
0061   /// if cloneRelations=false, the relations are not cloned and will be empty
0062   MutableMCRecoTrackerHitAssociation clone(bool cloneRelations=true) const;
0063
0064   /// destructor
0065   ~MutableMCRecoTrackerHitAssociation() = default;
0066
0067
0068 public:
0069
0070   /// Access the weight of this association
0071   float getWeight() const;
0072
0073
0074   /// Access the reference to the digitized hit
0075   const edm4eic::RawTrackerHit getRawHit() const;
0076   /// Access the reference to the simulated hit
0077   const edm4hep::SimTrackerHit getSimHit() const;
0078
0079   /// Set the weight of this association
0080   void setWeight(float value);
0081   /// Get mutable reference to weight of this association
0082   float& getWeight();
0083   /// Get reference to weight of this association
0084   [[deprecated("use getWeight instead")]]
0085   float& weight();
0086
0087
0088   /// Set the reference to the digitized hit
0089   void setRawHit(const edm4eic::RawTrackerHit& value);
0090   /// Set the reference to the simulated hit
0091   void setSimHit(const edm4hep::SimTrackerHit& value);
0092
0093
0094
0095
0096   /// check whether the object is actually available
0097   bool isAvailable() const;
0098   /// disconnect from MCRecoTrackerHitAssociationObj instance
0099   void unlink() { m_obj = podio::utils::MaybeSharedPtr<MCRecoTrackerHitAssociationObj>{nullptr}; }
0100
0101   bool operator==(const MutableMCRecoTrackerHitAssociation& other) const { return m_obj == other.m_obj; }
0102   bool operator==(const MCRecoTrackerHitAssociation& other) const;
0103
0104   bool operator!=(const MutableMCRecoTrackerHitAssociation& other) const { return !(*this == other); }
0105   bool operator!=(const MCRecoTrackerHitAssociation& other) const { return !(*this == other); }
0106
0107   // less comparison operator, so that objects can be e.g. stored in sets.
0108   bool operator<(const MutableMCRecoTrackerHitAssociation& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0109
0110   podio::ObjectID id() const { return getObjectID(); }
0111
0112   const podio::ObjectID getObjectID() const;
0113
0114   friend void swap(MutableMCRecoTrackerHitAssociation& a, MutableMCRecoTrackerHitAssociation& b) {
0115     using std::swap;
0116     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0117   }
0118
0119 private:
0120   /// constructor from existing MCRecoTrackerHitAssociationObj
0121   explicit MutableMCRecoTrackerHitAssociation(podio::utils::MaybeSharedPtr<MCRecoTrackerHitAssociationObj> obj);
0122
0123   podio::utils::MaybeSharedPtr<MCRecoTrackerHitAssociationObj> m_obj{nullptr};
0124 };
0125
0126 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0127 void to_json(nlohmann::json& j, const MutableMCRecoTrackerHitAssociation& value);
0128 #endif
0129
0130
0131 } // namespace edm4eic
0132
0133
0134 #endif