MutableMCRecoParticleAssociation.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableMCRecoParticleAssociation_H
#define EDM4EIC_MutableMCRecoParticleAssociation_H
 
#include "edm4eic/MCRecoParticleAssociationObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/MCRecoParticleAssociation.h"
 
#include <cstdint>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class ReconstructedParticle;
class MutableReconstructedParticle;
}
namespace edm4hep {
class MCParticle;
class MutableMCParticle;
}
 
 
namespace edm4eic {
 
 
/** @class MutableMCRecoParticleAssociation
 *  Used to keep track of the correspondence between MC and reconstructed particles
 *  @author: S. Joosten
 */
class MutableMCRecoParticleAssociation {
 
  friend class MCRecoParticleAssociationCollection;
  friend class MCRecoParticleAssociationMutableCollectionIterator;
  friend class MCRecoParticleAssociation;
 
public:
  using object_type = MCRecoParticleAssociation;
  using collection_type = MCRecoParticleAssociationCollection;
 
  /// default constructor
  MutableMCRecoParticleAssociation();
 
  /// Constructor initializing all members
  MutableMCRecoParticleAssociation(std::uint32_t simID, std::uint32_t recID, float weight);
 
  /// copy constructor
  MutableMCRecoParticleAssociation(const MutableMCRecoParticleAssociation& other) = default;
 
  /// copy-assignment operator
  MutableMCRecoParticleAssociation& operator=(MutableMCRecoParticleAssociation other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableMCRecoParticleAssociation clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableMCRecoParticleAssociation() = default;
 
 
public:
 
  /// Access the Index of corresponding MCParticle (position in MCParticles array)
  std::uint32_t getSimID() const;
 
  /// Access the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
  std::uint32_t getRecID() const;
 
  /// Access the weight of this association
  float getWeight() const;
 
 
  /// Access the reference to the reconstructed particle
  const edm4eic::ReconstructedParticle getRec() const;
  /// Access the reference to the Monte-Carlo particle
  const edm4hep::MCParticle getSim() const;
 
  /// Set the Index of corresponding MCParticle (position in MCParticles array)
  void setSimID(std::uint32_t value);
  /// Get mutable reference to Index of corresponding MCParticle (position in MCParticles array)
  std::uint32_t& getSimID();
  /// Get reference to Index of corresponding MCParticle (position in MCParticles array)
  [[deprecated("use getSimID instead")]]
  std::uint32_t& simID();
 
  /// Set the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
  void setRecID(std::uint32_t value);
  /// Get mutable reference to Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
  std::uint32_t& getRecID();
  /// Get reference to Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
  [[deprecated("use getRecID instead")]]
  std::uint32_t& recID();
 
  /// Set the weight of this association
  void setWeight(float value);
  /// Get mutable reference to weight of this association
  float& getWeight();
  /// Get reference to weight of this association
  [[deprecated("use getWeight instead")]]
  float& weight();
 
 
  /// Set the reference to the reconstructed particle
  void setRec(const edm4eic::ReconstructedParticle& value);
  /// Set the reference to the Monte-Carlo particle
  void setSim(const edm4hep::MCParticle& value);
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from MCRecoParticleAssociationObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj>{nullptr}; }
 
  bool operator==(const MutableMCRecoParticleAssociation& other) const { return m_obj == other.m_obj; }
  bool operator==(const MCRecoParticleAssociation& other) const;
 
  bool operator!=(const MutableMCRecoParticleAssociation& other) const { return !(*this == other); }
  bool operator!=(const MCRecoParticleAssociation& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableMCRecoParticleAssociation& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableMCRecoParticleAssociation& a, MutableMCRecoParticleAssociation& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing MCRecoParticleAssociationObj
  explicit MutableMCRecoParticleAssociation(podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj> obj);
 
  podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableMCRecoParticleAssociation& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif