ParametersT.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/

// ParametersT.h, (c) ATLAS Detector software
 
#ifndef TRKPARAMETERSBASE_PARAMETERS_T_H
#define TRKPARAMETERSBASE_PARAMETERS_T_H
 
#include "EventPrimitives/EventPrimitives.h"
#include "GeoPrimitives/GeoPrimitives.h"
#include "TrkEventPrimitives/SurfaceHolderImpl.h"
#include "TrkEventPrimitives/SurfaceTypes.h"
#include "TrkEventPrimitives/SurfaceUniquePtrT.h"
#include "TrkParametersBase/ParametersBase.h"
namespace Trk {
class MaterialEffectsEngine;

template<int DIM, class T, class S>
class ParametersT final
  : public ParametersBase<DIM, T>
  , public SurfaceUniqHolderImpl<S>
{
public:
  static_assert(
    (S::staticType == SurfaceType::Cone ||
     S::staticType == SurfaceType::Cylinder ||
     S::staticType == SurfaceType::Disc ||
     S::staticType == SurfaceType::Perigee ||
     S::staticType == SurfaceType::Plane || S::staticType == SurfaceType::Line),
    "The surface type must be one of Cone, Cylinder, Disc, Perigee, Plane, "
    "Line");

  ParametersT() = default;

  ParametersT(double loc1,
              double loc2,
              double phi,
              double theta,
              double qop,
              const S& surface,
              std::optional<AmgSymMatrix(DIM)> covariance = std::nullopt);

  ParametersT(const AmgVector(DIM) & parameters,
              const S& surface,
              std::optional<AmgSymMatrix(DIM)> covariance = std::nullopt);

  ParametersT(const Amg::Vector3D& position,
              const Amg::Vector3D& momentum,
              double charge,
              const S& surface,
              std::optional<AmgSymMatrix(DIM)> covariance = std::nullopt);

  ParametersT(const Amg::Vector3D& position,
              double phi,
              double theta,
              double qop,
              const S& surface,
              std::optional<AmgSymMatrix(DIM)> covariance = std::nullopt);

  ParametersT(const ParametersT<DIM, T, S>& rhs) = default;

  ParametersT(ParametersT<DIM, T, S>&& rhs) noexcept = default;

  ParametersT<DIM, T, S>& operator=(const ParametersT<DIM, T, S>& rhs) = default;

  ParametersT<DIM, T, S>& operator=(ParametersT<DIM, T, S>&& rhs) noexcept = default;
 
  //** Destructor */
  virtual ~ParametersT() = default;

  virtual bool hasSurface() const override final;

  virtual const S& associatedSurface() const override final;

  virtual bool operator==(
    const ParametersBase<DIM, T>& rhs) const override final;
 
  // Needed to avoid ambiguities with c++20.
  bool operator==(const ParametersT &rhs) const;

  virtual ParametersT<DIM, T, S>* clone() const override final;

  constexpr virtual ParametersType type() const override final;

  constexpr virtual SurfaceType surfaceType() const override final;

  virtual Amg::RotationMatrix3D measurementFrame() const override final;

  virtual MsgStream& dump(MsgStream& out) const override final;
  virtual std::ostream& dump(std::ostream& out) const override final;
 
private:
  /* Helper to factor in update of parameters*/
  virtual void updateParametersHelper(const AmgVector(DIM) &) override final;
 
protected:
  ParametersT(const AmgVector(DIM) & parameters,
              const S* surface,
              std::optional<AmgSymMatrix(DIM)> covariance = std::nullopt);
  /*
   * friends needed for Persistency
   */
  template<typename pars>
  friend class ::TrackParametersCovarianceCnv;
  friend class ::TrackParametersCnv_p2;
  friend class ::MeasuredPerigeeCnv_p1;
  template<class SURFACE_CNV, class ATA_SURFACE>
  friend class ::AtaSurfaceCnv_p1;

  friend class MaterialEffectsEngine;
};
} // end of namespace Trk
 
#include "TrkParametersBase/ParametersT.icc"
#endif // TRKTRACKPARAMETERS_H