include/edm4eic/MutableMCRecoParticleAssociation.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_MutableMCRecoParticleAssociation_H
0004 #define EDM4EIC_MutableMCRecoParticleAssociation_H
0005
0006 #include "edm4eic/MCRecoParticleAssociationObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4eic/MCRecoParticleAssociation.h"
0009
0010 #include <cstdint>
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 edm4eic {
0022 class MCRecoParticleAssociationCollection;
0023 class ReconstructedParticle;
0024 class MutableReconstructedParticle;
0025 }
0026 namespace edm4hep {
0027 class MCParticle;
0028 class MutableMCParticle;
0029 }
0030
0031
0032 namespace edm4eic {
0033
0034
0035 /** @class MutableMCRecoParticleAssociation
0036  *  Used to keep track of the correspondence between MC and reconstructed particles
0037  *  @author: S. Joosten
0038  */
0039 class MutableMCRecoParticleAssociation {
0040
0041   friend class MCRecoParticleAssociationCollection;
0042   friend class MCRecoParticleAssociationMutableCollectionIterator;
0043   friend class MCRecoParticleAssociation;
0044
0045 public:
0046   using object_type = MCRecoParticleAssociation;
0047   using collection_type = MCRecoParticleAssociationCollection;
0048
0049   /// default constructor
0050   MutableMCRecoParticleAssociation();
0051
0052   /// Constructor initializing all members
0053   MutableMCRecoParticleAssociation(std::uint32_t simID, std::uint32_t recID, float weight);
0054
0055   /// copy constructor
0056   MutableMCRecoParticleAssociation(const MutableMCRecoParticleAssociation& other) = default;
0057
0058   /// copy-assignment operator
0059   MutableMCRecoParticleAssociation& operator=(MutableMCRecoParticleAssociation other);
0060
0061   /// create a mutable deep-copy of the object with identical relations
0062   /// if cloneRelations=false, the relations are not cloned and will be empty
0063   MutableMCRecoParticleAssociation clone(bool cloneRelations=true) const;
0064
0065   /// destructor
0066   ~MutableMCRecoParticleAssociation() = default;
0067
0068
0069 public:
0070
0071   /// Access the Index of corresponding MCParticle (position in MCParticles array)
0072   std::uint32_t getSimID() const;
0073
0074   /// Access the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
0075   std::uint32_t getRecID() const;
0076
0077   /// Access the weight of this association
0078   float getWeight() const;
0079
0080
0081   /// Access the reference to the reconstructed particle
0082   const edm4eic::ReconstructedParticle getRec() const;
0083   /// Access the reference to the Monte-Carlo particle
0084   const edm4hep::MCParticle getSim() const;
0085
0086   /// Set the Index of corresponding MCParticle (position in MCParticles array)
0087   void setSimID(std::uint32_t value);
0088   /// Get mutable reference to Index of corresponding MCParticle (position in MCParticles array)
0089   std::uint32_t& getSimID();
0090   /// Get reference to Index of corresponding MCParticle (position in MCParticles array)
0091   [[deprecated("use getSimID instead")]]
0092   std::uint32_t& simID();
0093
0094   /// Set the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
0095   void setRecID(std::uint32_t value);
0096   /// Get mutable reference to Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
0097   std::uint32_t& getRecID();
0098   /// Get reference to Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
0099   [[deprecated("use getRecID instead")]]
0100   std::uint32_t& recID();
0101
0102   /// Set the weight of this association
0103   void setWeight(float value);
0104   /// Get mutable reference to weight of this association
0105   float& getWeight();
0106   /// Get reference to weight of this association
0107   [[deprecated("use getWeight instead")]]
0108   float& weight();
0109
0110
0111   /// Set the reference to the reconstructed particle
0112   void setRec(const edm4eic::ReconstructedParticle& value);
0113   /// Set the reference to the Monte-Carlo particle
0114   void setSim(const edm4hep::MCParticle& value);
0115
0116
0117
0118
0119   /// check whether the object is actually available
0120   bool isAvailable() const;
0121   /// disconnect from MCRecoParticleAssociationObj instance
0122   void unlink() { m_obj = podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj>{nullptr}; }
0123
0124   bool operator==(const MutableMCRecoParticleAssociation& other) const { return m_obj == other.m_obj; }
0125   bool operator==(const MCRecoParticleAssociation& other) const;
0126
0127   bool operator!=(const MutableMCRecoParticleAssociation& other) const { return !(*this == other); }
0128   bool operator!=(const MCRecoParticleAssociation& other) const { return !(*this == other); }
0129
0130   // less comparison operator, so that objects can be e.g. stored in sets.
0131   bool operator<(const MutableMCRecoParticleAssociation& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0132
0133   podio::ObjectID id() const { return getObjectID(); }
0134
0135   const podio::ObjectID getObjectID() const;
0136
0137   friend void swap(MutableMCRecoParticleAssociation& a, MutableMCRecoParticleAssociation& b) {
0138     using std::swap;
0139     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0140   }
0141
0142 private:
0143   /// constructor from existing MCRecoParticleAssociationObj
0144   explicit MutableMCRecoParticleAssociation(podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj> obj);
0145
0146   podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj> m_obj{nullptr};
0147 };
0148
0149 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0150 void to_json(nlohmann::json& j, const MutableMCRecoParticleAssociation& value);
0151 #endif
0152
0153
0154 } // namespace edm4eic
0155
0156
0157 #endif