TrackParameters.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_TrackParameters_H
#define EDM4EIC_TrackParameters_H
 
#include "edm4eic/TrackParametersObj.h"
 
#include "edm4eic/Cov6f.h"
#include "edm4hep/Vector2f.h"
#include <cstdint>
 
#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 TrackParametersCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::TrackParameters& obj);
};
 
namespace edm4eic {
 
class MutableTrackParameters;
class TrackParametersCollection;
class TrackParametersCollectionData;
 
/** @class TrackParameters
 *  ACTS Bound Track parameters
 *  @author: W. Armstrong, S. Joosten, J. Osborn
 */
class TrackParameters {
 
  friend class MutableTrackParameters;
  friend class TrackParametersCollection;
  friend class edm4eic::TrackParametersCollectionData;
  friend class TrackParametersCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const TrackParameters & obj);
 
public:
  using mutable_type = MutableTrackParameters;
  using collection_type = TrackParametersCollection;
 
  /// default constructor
  TrackParameters();
 
  /// Constructor initializing all members
  TrackParameters(std::int32_t type, std::uint64_t surface, edm4hep::Vector2f loc, float theta, float phi, float qOverP, float time, std::int32_t pdg, edm4eic::Cov6f covariance);
 
  /// copy constructor
  TrackParameters(const TrackParameters& other) = default;
 
  /// copy-assignment operator
  TrackParameters& operator=(TrackParameters other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrackParameters clone(bool cloneRelations=true) const;
 
  /// destructor
  ~TrackParameters() = default;
 
  /// converting constructor from mutable object
  TrackParameters(const MutableTrackParameters& other);
 
  static TrackParameters makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::TrackParameters";
 
  /// Access the Type of track parameters (-1/seed, 0/head, ...)
  std::int32_t getType() const;
 
  /// Access the Surface for bound parameters (geometryID)
  std::uint64_t getSurface() const;
 
  /// Access the 2D location on surface
  const edm4hep::Vector2f& getLoc() const;
 
  /// Access the Track polar angle [rad]
  float getTheta() const;
 
  /// Access the Track azimuthal angle [rad]
  float getPhi() const;
 
  /// Access the [e/GeV]
  float getQOverP() const;
 
  /// Access the Track time [ns]
  float getTime() const;
 
  /// Access the pdg pid for these parameters
  std::int32_t getPdg() const;
 
  /// Access the Full covariance in basis [l0,l1,theta,phi,q/p,t]
  const edm4eic::Cov6f& getCovariance() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackParametersObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackParametersObj>{nullptr}; }
 
  bool operator==(const TrackParameters& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableTrackParameters& other) const;
 
  bool operator!=(const TrackParameters& other) const { return !(*this == other); }
  bool operator!=(const MutableTrackParameters& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const TrackParameters& 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(TrackParameters& a, TrackParameters& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackParametersObj
  explicit TrackParameters(podio::utils::MaybeSharedPtr<TrackParametersObj> obj);
  TrackParameters(TrackParametersObj* obj);
 
  podio::utils::MaybeSharedPtr<TrackParametersObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const TrackParameters& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const TrackParameters& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif