MutableReconstructedParticle.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableReconstructedParticle_H
#define EDM4EIC_MutableReconstructedParticle_H
 
#include "edm4eic/ReconstructedParticleObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/ReconstructedParticle.h"
 
#include "edm4eic/Cluster.h"
#include "edm4eic/Cov4f.h"
#include "edm4eic/Track.h"
#include "edm4hep/ParticleID.h"
#include "edm4hep/Vector3f.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#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 ReconstructedParticleCollection;
class Vertex;
class MutableVertex;
}
namespace edm4hep {
class ParticleID;
class MutableParticleID;
}
 
 
namespace edm4eic {
 
 
/** @class MutableReconstructedParticle
 *  EIC Reconstructed Particle
 *  @author: W. Armstrong, S. Joosten, F. Gaede
 */
class MutableReconstructedParticle {
 
  friend class ReconstructedParticleCollection;
  friend class ReconstructedParticleMutableCollectionIterator;
  friend class ReconstructedParticle;
 
public:
  using object_type = ReconstructedParticle;
  using collection_type = ReconstructedParticleCollection;
 
  /// default constructor
  MutableReconstructedParticle();
 
  /// Constructor initializing all members
  MutableReconstructedParticle(std::int32_t type, float energy, edm4hep::Vector3f momentum, edm4hep::Vector3f referencePoint, float charge, float mass, float goodnessOfPID, edm4eic::Cov4f covMatrix, std::int32_t PDG);
 
  /// copy constructor
  MutableReconstructedParticle(const MutableReconstructedParticle& other) = default;
 
  /// copy-assignment operator
  MutableReconstructedParticle& operator=(MutableReconstructedParticle other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableReconstructedParticle clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableReconstructedParticle() = default;
 
 
public:
 
  /// Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
  std::int32_t getType() const;
 
  /// Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
  float getEnergy() const;
 
  /// Access the [GeV] particle momentum. Four momentum state is not kept consistent internally.
  const edm4hep::Vector3f& getMomentum() const;
 
  /// Access the [mm] reference, i.e. where the particle has been measured
  const edm4hep::Vector3f& getReferencePoint() const;
 
  /// Access the charge of the reconstructed particle.
  float getCharge() const;
 
  /// Access the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
  float getMass() const;
 
  /// Access the overall goodness of the PID on a scale of [0;1]
  float getGoodnessOfPID() const;
 
  /// Access the covariance matrix of the reconstructed particle 4vector (10 parameters).
  const edm4eic::Cov4f& getCovMatrix() const;
 
  /// Access the PDG code for this particle
  std::int32_t getPDG() const;
 
 
  /// Access the Start vertex associated to this particle
  const edm4eic::Vertex getStartVertex() const;
  /// Access the particle ID used for the kinematics of this particle
  const edm4hep::ParticleID getParticleIDUsed() const;
 
  /// Set the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
  void setType(std::int32_t value);
  /// Get mutable reference to type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
  std::int32_t& getType();
  /// Get reference to type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
  [[deprecated("use getType instead")]]
  std::int32_t& type();
 
  /// Set the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
  void setEnergy(float value);
  /// Get mutable reference to [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
  float& getEnergy();
  /// Get reference to [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
  [[deprecated("use getEnergy instead")]]
  float& energy();
 
  /// Set the [GeV] particle momentum. Four momentum state is not kept consistent internally.
  void setMomentum(edm4hep::Vector3f value);
  /// Get mutable reference to [GeV] particle momentum. Four momentum state is not kept consistent internally.
  edm4hep::Vector3f& getMomentum();
  /// Get reference to [GeV] particle momentum. Four momentum state is not kept consistent internally.
  [[deprecated("use getMomentum instead")]]
  edm4hep::Vector3f& momentum();
 
  /// Set the [mm] reference, i.e. where the particle has been measured
  void setReferencePoint(edm4hep::Vector3f value);
  /// Get mutable reference to [mm] reference, i.e. where the particle has been measured
  edm4hep::Vector3f& getReferencePoint();
  /// Get reference to [mm] reference, i.e. where the particle has been measured
  [[deprecated("use getReferencePoint instead")]]
  edm4hep::Vector3f& referencePoint();
 
  /// Set the charge of the reconstructed particle.
  void setCharge(float value);
  /// Get mutable reference to charge of the reconstructed particle.
  float& getCharge();
  /// Get reference to charge of the reconstructed particle.
  [[deprecated("use getCharge instead")]]
  float& charge();
 
  /// Set the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
  void setMass(float value);
  /// Get mutable reference to [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
  float& getMass();
  /// Get reference to [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
  [[deprecated("use getMass instead")]]
  float& mass();
 
  /// Set the overall goodness of the PID on a scale of [0;1]
  void setGoodnessOfPID(float value);
  /// Get mutable reference to overall goodness of the PID on a scale of [0;1]
  float& getGoodnessOfPID();
  /// Get reference to overall goodness of the PID on a scale of [0;1]
  [[deprecated("use getGoodnessOfPID instead")]]
  float& goodnessOfPID();
 
  /// Set the covariance matrix of the reconstructed particle 4vector (10 parameters).
  void setCovMatrix(edm4eic::Cov4f value);
  /// Get mutable reference to covariance matrix of the reconstructed particle 4vector (10 parameters).
  edm4eic::Cov4f& getCovMatrix();
  /// Get reference to covariance matrix of the reconstructed particle 4vector (10 parameters).
  [[deprecated("use getCovMatrix instead")]]
  edm4eic::Cov4f& covMatrix();
 
  /// Set the PDG code for this particle
  void setPDG(std::int32_t value);
  /// Get mutable reference to PDG code for this particle
  std::int32_t& getPDG();
  /// Get reference to PDG code for this particle
  [[deprecated("use getPDG instead")]]
  std::int32_t& PDG();
 
 
  /// Set the Start vertex associated to this particle
  void setStartVertex(const edm4eic::Vertex& value);
  /// Set the particle ID used for the kinematics of this particle
  void setParticleIDUsed(const edm4hep::ParticleID& value);
 
  void addToClusters(const edm4eic::Cluster&);
  std::size_t clusters_size() const;
  edm4eic::Cluster getClusters(std::size_t) const;
  std::vector<edm4eic::Cluster>::const_iterator clusters_begin() const;
  std::vector<edm4eic::Cluster>::const_iterator clusters_end() const;
  podio::RelationRange<edm4eic::Cluster> getClusters() const;
  void addToTracks(const edm4eic::Track&);
  std::size_t tracks_size() const;
  edm4eic::Track getTracks(std::size_t) const;
  std::vector<edm4eic::Track>::const_iterator tracks_begin() const;
  std::vector<edm4eic::Track>::const_iterator tracks_end() const;
  podio::RelationRange<edm4eic::Track> getTracks() const;
  void addToParticles(const edm4eic::ReconstructedParticle&);
  std::size_t particles_size() const;
  edm4eic::ReconstructedParticle getParticles(std::size_t) const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator particles_begin() const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator particles_end() const;
  podio::RelationRange<edm4eic::ReconstructedParticle> getParticles() const;
  void addToParticleIDs(const edm4hep::ParticleID&);
  std::size_t particleIDs_size() const;
  edm4hep::ParticleID getParticleIDs(std::size_t) const;
  std::vector<edm4hep::ParticleID>::const_iterator particleIDs_begin() const;
  std::vector<edm4hep::ParticleID>::const_iterator particleIDs_end() const;
  podio::RelationRange<edm4hep::ParticleID> getParticleIDs() const;
 
 bool isCompound() const {return particles_size() > 0;}
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from ReconstructedParticleObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<ReconstructedParticleObj>{nullptr}; }
 
  bool operator==(const MutableReconstructedParticle& other) const { return m_obj == other.m_obj; }
  bool operator==(const ReconstructedParticle& other) const;
 
  bool operator!=(const MutableReconstructedParticle& other) const { return !(*this == other); }
  bool operator!=(const ReconstructedParticle& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableReconstructedParticle& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableReconstructedParticle& a, MutableReconstructedParticle& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing ReconstructedParticleObj
  explicit MutableReconstructedParticle(podio::utils::MaybeSharedPtr<ReconstructedParticleObj> obj);
 
  podio::utils::MaybeSharedPtr<ReconstructedParticleObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableReconstructedParticle& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif