MaterialEffectsBase.h

Go to the documentation of this file.

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

// MaterialEffectsBase.h, (c) ATLAS Detector software
 
#ifndef TRKMATERIALONTRACK_MATERIALEFFECTSBASE_H
#define TRKMATERIALONTRACK_MATERIALEFFECTSBASE_H
 
#include "TrkSurfaces/SurfaceHolders.h"
//
#include <bitset>
#include <iosfwd>
#include <memory>
 
class MsgStream;
class TrackCollectionCnv;
class MaterialEffectsBaseCnv_p1;
class MaterialEffectsBaseCnv_p2;
class MaterialEffectsOnTrackCnv_p2;
class ScatteringAngleOnTrackCnv_p1;
 
namespace Trk {

class MaterialEffectsBase : public SurfacePtrHolderDetEl
{
public:
  enum MaterialEffectsDerivedType{
    ESTIMATED_BREM_ON_TRACK = 0,
    MATERIAL_EFFECTS_ON_TRACK,
    NTYPES
  };
  enum MaterialEffectsType
  {
    ScatteringEffects = 0,
    // trouble: avoid name clash Trk::Energyloss vs MET::EnergyLoss
    EnergyLossEffects = 1,
    MaterialThickness = 2,
    BremPoint = 3,
    UsesMeasurement = 4,
    FittedMaterialEffects = 5,
    Unknown = 6,
    NumberOfMaterialEffectsTypes = 7
    // WARNING need to edit MaterialEffectsOnTrack.cxx if these enums change
  };

  MaterialEffectsBase();
  MaterialEffectsBase(
    double thicknessInX0,
    const Surface& assocSurf,
    const std::bitset<MaterialEffectsBase::NumberOfMaterialEffectsTypes>&
      typePattern);
  virtual ~MaterialEffectsBase() = default;

  virtual MaterialEffectsBase* clone() const = 0;

  std::unique_ptr<MaterialEffectsBase> uniqueClone() const
  {
    return std::unique_ptr<MaterialEffectsBase>(clone());
  }

  double thicknessInX0() const;

  const Surface& associatedSurface() const;

  bool type(const MaterialEffectsType& type) const;
  
 virtual  MaterialEffectsDerivedType derivedType() const = 0;

  std::string dumpType() const;

  virtual MsgStream& dump(MsgStream& sl) const;
  virtual std::ostream& dump(std::ostream& sl) const;
 
protected:
  virtual void setValues(const Surface* assocSurface);
  MaterialEffectsBase(const MaterialEffectsBase& rhs) = default;
  MaterialEffectsBase& operator=(const MaterialEffectsBase& rhs) = default;
  MaterialEffectsBase(MaterialEffectsBase&& rhs) = default;
  MaterialEffectsBase& operator=(MaterialEffectsBase&& rhs) = default;
 
private:
  friend class ::MaterialEffectsBaseCnv_p1;
  friend class ::MaterialEffectsBaseCnv_p2;
  friend class ::MaterialEffectsOnTrackCnv_p2;
  friend class ::TrackCollectionCnv;
  friend class ::ScatteringAngleOnTrackCnv_p1;

  double m_tInX0{};
  long m_typeFlags{};
};

MsgStream&
operator<<(MsgStream& sl, const MaterialEffectsBase& meb);

std::ostream&
operator<<(std::ostream& sl, const MaterialEffectsBase& meb);
 
} // end ns
 
#include "TrkMaterialOnTrack/MaterialEffectsBase.icc"
#endif // TRKMATERIALONTRACK_MATERIALEFFECTSBASE_H