Track.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_Track_H
#define EDM4EIC_Track_H
 
#include "edm4eic/TrackObj.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 "podio/detail/OrderKey.h"
 
#include <ostream>
#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 podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::Track& obj);
};
 
namespace edm4eic {
 
class MutableTrack;
class TrackCollection;
class TrackCollectionData;
 
/** @class Track
 *  Track information at the vertex
 *  @author: S. Joosten, J. Osborn
 */
class Track {
 
  friend class MutableTrack;
  friend class TrackCollection;
  friend class edm4eic::TrackCollectionData;
  friend class TrackCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const Track & obj);
 
public:
  using mutable_type = MutableTrack;
  using collection_type = TrackCollection;
 
  /// default constructor
  Track();
 
  /// Constructor initializing all members
  Track(std::int32_t type, edm4hep::Vector3f position, edm4hep::Vector3f momentum, edm4eic::Cov6f positionMomentumCovariance, float time, float timeError, float charge, float chi2, std::uint32_t ndf, std::int32_t pdg);
 
  /// copy constructor
  Track(const Track& other) = default;
 
  /// copy-assignment operator
  Track& operator=(Track other);
 
  /// 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
  ~Track() = default;
 
  /// converting constructor from mutable object
  Track(const MutableTrack& other);
 
  static Track makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::Track";
 
  /// 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;
 
  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;
  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 Track& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableTrack& other) const;
 
  bool operator!=(const Track& other) const { return !(*this == other); }
  bool operator!=(const MutableTrack& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Track& 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(Track& a, Track& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackObj
  explicit Track(podio::utils::MaybeSharedPtr<TrackObj> obj);
  Track(TrackObj* obj);
 
  podio::utils::MaybeSharedPtr<TrackObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const Track& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const Track& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif