ParametersBase.h

Go to the documentation of this file.

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

// ParametersBase.h, (c) ATLAS Detector software
 
#ifndef TRKPARAMETERSBASE_PARAMETERSBASE_H
#define TRKPARAMETERSBASE_PARAMETERSBASE_H
//
#include "TrkParametersBase/ParametersCommon.h"
//system
#include <memory>
#include <type_traits>
#include <optional>
#include <iosfwd>
 
class MsgStream;
 
template<typename T>
class TrackParametersCovarianceCnv;
class TrackParametersCnv_p2;
class MeasuredPerigeeCnv_p1;
template<class SURFACE_CNV, class ATA_SURFACE>
class AtaSurfaceCnv_p1;
 
namespace Trk {
class Surface;
class MaterialEffectsEngine;
 

 
template<int DIM, class T>
class ParametersBase : public ParametersCommon<DIM,T>
{
public:
  virtual ~ParametersBase() = default;

  double charge() const;

  const Amg::Vector3D& position() const;

  const Amg::Vector3D& momentum() const;

  double pT() const;

  double eta() const;

  virtual bool operator==(const ParametersBase<DIM, T>&) const;

  virtual bool hasSurface() const override = 0;

  virtual const Surface& associatedSurface() const override = 0;

  virtual Amg::RotationMatrix3D measurementFrame() const override = 0;

  virtual ParametersBase<DIM, T>* clone() const override = 0;

  std::unique_ptr<ParametersBase<DIM, T>> uniqueClone() const{
    return std::unique_ptr<ParametersBase<DIM, T>>(this->clone());
  }

  constexpr virtual ParametersType type() const override = 0;

  constexpr virtual SurfaceType surfaceType() const override = 0;

  virtual MsgStream& dump(MsgStream& out) const;
  virtual std::ostream& dump(std::ostream& out) const;
 
protected:
  /*
   * This is an abstract class and we can not instantiate objects directly.
   * In the other hand derived classed can use ctors
   */
  ParametersBase() = default;
  ParametersBase(ParametersBase&&) noexcept = default;
  ParametersBase& operator=(ParametersBase&&) noexcept  = default;
  ParametersBase(const ParametersBase&) = default;
  ParametersBase& operator=(const ParametersBase&) = default;
 
  /* Helper ctors for derived classes*/
  ParametersBase(const AmgVector(DIM) parameters,
                 std::optional<AmgSymMatrix(DIM)>&& covariance,
                 const T chargeDef);
 
  ParametersBase(std::optional<AmgSymMatrix(DIM)>&& covariance);
 
  ParametersBase(const AmgVector(DIM) & parameters,
                 std::optional<AmgSymMatrix(DIM)>&& covariance = std::nullopt);
 
  virtual void updateParametersHelper(const AmgVector(DIM) &) override = 0;
  /*
   * Add dependent names into scope
   */
  using ParametersCommon<DIM, T>::m_parameters;
  using ParametersCommon<DIM, T>::m_covariance;
  using ParametersCommon<DIM, T>::m_chargeDef;
  Amg::Vector3D m_position; 
  Amg::Vector3D m_momentum; 
};

template<int DIM, class T>
MsgStream&
operator<<(MsgStream& sl, const Trk::ParametersBase<DIM, T>& tp);
 
template<int DIM, class T>
std::ostream&
operator<<(std::ostream& sl, const Trk::ParametersBase<DIM, T>& tp);
 
} // end of namespace Trk
 
#include "TrkParametersBase/ParametersBase.icc"
 
#endif