include/edm4hep/MutableRecoParticleVertexAssociation.h

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