MutableTrack.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTrack_H
#define EDM4EIC_MutableTrack_H
 
#include "edm4eic/TrackObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Track.h"
 
#include "edm4eic/Cov6f.h"
#include "edm4eic/Measurement2D.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 TrackCollection;
class Trajectory;
class MutableTrajectory;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTrack
 *  Track information at the vertex
 *  @author: S. Joosten, J. Osborn
 */
class MutableTrack {
 
  friend class TrackCollection;
  friend class TrackMutableCollectionIterator;
  friend class Track;
 
public:
  using object_type = Track;
  using collection_type = TrackCollection;
 
  /// default constructor
  MutableTrack();
 
  /// Constructor initializing all members
  MutableTrack(const std::int32_t type, const edm4hep::Vector3f& position, const edm4hep::Vector3f& momentum, const edm4eic::Cov6f& positionMomentumCovariance, const float time, const float timeError, const float charge, const float chi2, const std::uint32_t ndf, const std::int32_t pdg);
 
  /// copy constructor
  MutableTrack(const MutableTrack& other) = default;
 
  /// copy-assignment operator
  MutableTrack& operator=(MutableTrack other) &; // Rebind this to other's internal object
  MutableTrack& operator=(MutableTrack other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrack clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableTrack() = default;
 
 
public:
 
  /// Access the Flag that defines the type of track
  std::int32_t getType() const;
 
  /// Access the Track 3-position at the vertex
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the Track 3-momentum at the vertex [GeV]
  const edm4hep::Vector3f& getMomentum() const;
 
  /// Access the Covariance matrix in basis [x,y,z,px,py,pz]
  const edm4eic::Cov6f& getPositionMomentumCovariance() const;
 
  /// Access the Track time at the vertex [ns]
  float getTime() const;
 
  /// Access the Error on the track vertex time
  float getTimeError() const;
 
  /// Access the Particle charge
  float getCharge() const;
 
  /// Access the Total chi2
  float getChi2() const;
 
  /// Access the Number of degrees of freedom
  std::uint32_t getNdf() const;
 
  /// Access the PDG particle ID hypothesis
  std::int32_t getPdg() const;
 
 
  /// Access the Trajectory of this track
  const edm4eic::Trajectory getTrajectory() const;
 
  /// Set the Flag that defines the type of track
  void setType(const std::int32_t type);
  /// Get mutable reference to Flag that defines the type of track
  std::int32_t& getType();
  /// Get reference to Flag that defines the type of track
  [[deprecated("use getType instead")]]
  std::int32_t& type();
 
  /// Set the Track 3-position at the vertex
  void setPosition(const edm4hep::Vector3f& position);
  /// Get mutable reference to Track 3-position at the vertex
  edm4hep::Vector3f& getPosition();
  /// Get reference to Track 3-position at the vertex
  [[deprecated("use getPosition instead")]]
  edm4hep::Vector3f& position();
 
  /// Set the Track 3-momentum at the vertex [GeV]
  void setMomentum(const edm4hep::Vector3f& momentum);
  /// Get mutable reference to Track 3-momentum at the vertex [GeV]
  edm4hep::Vector3f& getMomentum();
  /// Get reference to Track 3-momentum at the vertex [GeV]
  [[deprecated("use getMomentum instead")]]
  edm4hep::Vector3f& momentum();
 
  /// Set the Covariance matrix in basis [x,y,z,px,py,pz]
  void setPositionMomentumCovariance(const edm4eic::Cov6f& positionMomentumCovariance);
  /// Get mutable reference to Covariance matrix in basis [x,y,z,px,py,pz]
  edm4eic::Cov6f& getPositionMomentumCovariance();
  /// Get reference to Covariance matrix in basis [x,y,z,px,py,pz]
  [[deprecated("use getPositionMomentumCovariance instead")]]
  edm4eic::Cov6f& positionMomentumCovariance();
 
  /// Set the Track time at the vertex [ns]
  void setTime(const float time);
  /// Get mutable reference to Track time at the vertex [ns]
  float& getTime();
  /// Get reference to Track time at the vertex [ns]
  [[deprecated("use getTime instead")]]
  float& time();
 
  /// Set the Error on the track vertex time
  void setTimeError(const float timeError);
  /// Get mutable reference to Error on the track vertex time
  float& getTimeError();
  /// Get reference to Error on the track vertex time
  [[deprecated("use getTimeError instead")]]
  float& timeError();
 
  /// Set the Particle charge
  void setCharge(const float charge);
  /// Get mutable reference to Particle charge
  float& getCharge();
  /// Get reference to Particle charge
  [[deprecated("use getCharge instead")]]
  float& charge();
 
  /// Set the Total chi2
  void setChi2(const float chi2);
  /// Get mutable reference to Total chi2
  float& getChi2();
  /// Get reference to Total chi2
  [[deprecated("use getChi2 instead")]]
  float& chi2();
 
  /// Set the Number of degrees of freedom
  void setNdf(const std::uint32_t ndf);
  /// Get mutable reference to Number of degrees of freedom
  std::uint32_t& getNdf();
  /// Get reference to Number of degrees of freedom
  [[deprecated("use getNdf instead")]]
  std::uint32_t& ndf();
 
  /// Set the PDG particle ID hypothesis
  void setPdg(const std::int32_t pdg);
  /// Get mutable reference to PDG particle ID hypothesis
  std::int32_t& getPdg();
  /// Get reference to PDG particle ID hypothesis
  [[deprecated("use getPdg instead")]]
  std::int32_t& pdg();
 
 
  /// Set the Trajectory of this track
  void setTrajectory(const edm4eic::Trajectory& value);
 
  void addToMeasurements(const edm4eic::Measurement2D&);
  std::size_t measurements_size() const;
  edm4eic::Measurement2D getMeasurements(std::size_t) const;
  std::vector<edm4eic::Measurement2D>::const_iterator measurements_begin() const;
  std::vector<edm4eic::Measurement2D>::const_iterator measurements_end() const;
  podio::RelationRange<edm4eic::Measurement2D> getMeasurements() 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;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackObj>{nullptr}; }
 
  bool operator==(const MutableTrack& other) const { return m_obj == other.m_obj; }
  bool operator==(const Track& other) const;
 
  bool operator!=(const MutableTrack& other) const { return !(*this == other); }
  bool operator!=(const Track& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrack& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend std::hash<MutableTrack>;
 
  friend void swap(MutableTrack& a, MutableTrack& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackObj
  explicit MutableTrack(podio::utils::MaybeSharedPtr<TrackObj> obj);
 
  podio::utils::MaybeSharedPtr<TrackObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTrack& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableTrack> {
  std::size_t operator()(const edm4eic::MutableTrack& obj) const {
    return std::hash<edm4eic::TrackObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif