ATLAS Offline Software
Classes | Public Member Functions | Static Public Member Functions | List of all members
Trk::IMaterialEffectsUpdator Class Referenceabstract

#include <IMaterialEffectsUpdator.h>

Inheritance diagram for Trk::IMaterialEffectsUpdator:
Collaboration diagram for Trk::IMaterialEffectsUpdator:

Classes

class  ICache
 Cache class to allow passing information to/between calls. More...
 

Public Member Functions

virtual ~IMaterialEffectsUpdator ()
 Virtual destructor. More...
 
virtual ICache getCache () const
 Creates an instance of the cache to be used. More...
 
virtual std::unique_ptr< TrackParametersupdate (ICache &icache, const TrackParameters *param, const Layer &sf, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface (full update for a layer): The parameters are given as a pointer owned by the caller. More...
 
virtual std::unique_ptr< TrackParametersupdate (ICache &icache, const TrackParameters *param, const MaterialEffectsOnTrack &meff, Trk::ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 User updator interface (full update for a layer): The parameters are given as a pointer owned by the caller. More...
 
virtual std::unique_ptr< TrackParameterspreUpdate (ICache &icache, const TrackParameters *param, const Layer &sf, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface (pre-update for a layer): The parameters are given as a pointer owned by the caller. More...
 
virtual std::unique_ptr< TrackParameterspostUpdate (ICache &icache, const TrackParameters &param, const Layer &sf, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface (pre-update for a layer): The parameters are given as a pointer owned by the caller. More...
 
virtual std::unique_ptr< TrackParametersupdate (ICache &icache, const TrackParameters &param, const MaterialProperties &mprop, double pathcorrection, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface: The parameters are given as a pointer owned by the caller. More...
 
virtual void validationAction (ICache &icache) const =0
 Validation Action: More...
 
virtual void modelAction (ICache &icache, const TrackParameters *param=nullptr) const =0
 Model Action: More...
 
virtual std::unique_ptr< TrackParametersupdate (const TrackParameters *param, const Layer &sf, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface (full update for a layer): More...
 
virtual std::unique_ptr< TrackParametersupdate (const TrackParameters *param, const MaterialEffectsOnTrack &meff, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 User updator interface (full update for a layer): More...
 
virtual std::unique_ptr< TrackParameterspreUpdate (const TrackParameters *param, const Layer &sf, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface (pre-update for a layer): More...
 
virtual std::unique_ptr< TrackParameterspostUpdate (const TrackParameters &param, const Layer &sf, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface (pre-update for a layer): More...
 
virtual std::unique_ptr< TrackParametersupdate (const TrackParameters &param, const MaterialProperties &mprop, double pathcorrection, PropDirection dir=alongMomentum, ParticleHypothesis particle=pion, MaterialUpdateMode matupmode=addNoise) const =0
 Updator interface: MaterialProperties based material update. More...
 
virtual void validationAction () const =0
 Validation Action: outside access to internal validation steps Optional. More...
 
virtual void modelAction (const TrackParameters *param=nullptr) const =0
 Model Action: Provides the possibility of doing non-local MaterialEffectsUpdates for different models Optional. More...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 AlgTool and IAlgTool interface methods. More...
 

Detailed Description

Interface class for the updater AlgTool, it inherits from IAlgTool

Detailed information about private members and member functions can be found in the actual implementation class MaterialEffectsUpdator which inherits from this one.

Author
Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch
Christos Anastopoulos (Athena MT)

Definition at line 44 of file IMaterialEffectsUpdator.h.

Constructor & Destructor Documentation

◆ ~IMaterialEffectsUpdator()

virtual Trk::IMaterialEffectsUpdator::~IMaterialEffectsUpdator ( )
inlinevirtual

Virtual destructor.

Definition at line 49 of file IMaterialEffectsUpdator.h.

49 {}

Member Function Documentation

◆ getCache()

virtual ICache Trk::IMaterialEffectsUpdator::getCache ( ) const
inlinevirtual

Creates an instance of the cache to be used.

by the client.

Definition at line 87 of file IMaterialEffectsUpdator.h.

87 { return {}; }

◆ interfaceID()

static const InterfaceID& Trk::IMaterialEffectsUpdator::interfaceID ( )
inlinestatic

AlgTool and IAlgTool interface methods.

Definition at line 52 of file IMaterialEffectsUpdator.h.

53  {
54  return IID_IMaterialEffectsUpdator;
55  }

◆ modelAction() [1/2]

virtual void Trk::IMaterialEffectsUpdator::modelAction ( const TrackParameters param = nullptr) const
pure virtual

Model Action: Provides the possibility of doing non-local MaterialEffectsUpdates for different models Optional.

Implemented in Trk::MaterialEffectsUpdator.

◆ modelAction() [2/2]

virtual void Trk::IMaterialEffectsUpdator::modelAction ( ICache icache,
const TrackParameters param = nullptr 
) const
pure virtual

Model Action:

Implemented in Trk::MaterialEffectsUpdator.

◆ postUpdate() [1/2]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::postUpdate ( const TrackParameters param,
const Layer sf,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface (pre-update for a layer):

Implemented in Trk::MaterialEffectsUpdator.

◆ postUpdate() [2/2]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::postUpdate ( ICache icache,
const TrackParameters param,
const Layer sf,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface (pre-update for a layer): The parameters are given as a pointer owned by the caller.

The returned ptr is owned by the caller Layer-based material update if the postUpdate fails, it returns 0

Implemented in Trk::MaterialEffectsUpdator.

◆ preUpdate() [1/2]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::preUpdate ( const TrackParameters param,
const Layer sf,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface (pre-update for a layer):

Implemented in Trk::MaterialEffectsUpdator.

◆ preUpdate() [2/2]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::preUpdate ( ICache icache,
const TrackParameters param,
const Layer sf,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface (pre-update for a layer): The parameters are given as a pointer owned by the caller.

The returned ptr is owned by the caller

Implemented in Trk::MaterialEffectsUpdator.

◆ update() [1/6]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::update ( const TrackParameters param,
const MaterialProperties mprop,
double  pathcorrection,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface: MaterialProperties based material update.

  • used by all Layer-based methods

Implemented in Trk::MaterialEffectsUpdator.

◆ update() [2/6]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::update ( const TrackParameters param,
const Layer sf,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface (full update for a layer):

Implemented in Trk::MaterialEffectsUpdator.

◆ update() [3/6]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::update ( const TrackParameters param,
const MaterialEffectsOnTrack meff,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

User updator interface (full update for a layer):

Implemented in Trk::MaterialEffectsUpdator.

◆ update() [4/6]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::update ( ICache icache,
const TrackParameters param,
const MaterialProperties mprop,
double  pathcorrection,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface: The parameters are given as a pointer owned by the caller.

The returned ptr is owned by the caller

  • used by all Layer-based methods

Implemented in Trk::MaterialEffectsUpdator.

◆ update() [5/6]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::update ( ICache icache,
const TrackParameters param,
const Layer sf,
PropDirection  dir = alongMomentum,
ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

Updator interface (full update for a layer): The parameters are given as a pointer owned by the caller.

The returned ptr is owned by the caller.

Implemented in Trk::MaterialEffectsUpdator.

◆ update() [6/6]

virtual std::unique_ptr<TrackParameters> Trk::IMaterialEffectsUpdator::update ( ICache icache,
const TrackParameters param,
const MaterialEffectsOnTrack meff,
Trk::ParticleHypothesis  particle = pion,
MaterialUpdateMode  matupmode = addNoise 
) const
pure virtual

User updator interface (full update for a layer): The parameters are given as a pointer owned by the caller.

The returned ptr is owned by the caller

Implemented in Trk::MaterialEffectsUpdator.

◆ validationAction() [1/2]

virtual void Trk::IMaterialEffectsUpdator::validationAction ( ) const
pure virtual

Validation Action: outside access to internal validation steps Optional.

Implemented in Trk::MaterialEffectsUpdator.

◆ validationAction() [2/2]

virtual void Trk::IMaterialEffectsUpdator::validationAction ( ICache icache) const
pure virtual

Validation Action:

Implemented in Trk::MaterialEffectsUpdator.


The documentation for this class was generated from the following file: