Trk::StaticEngine Class Reference

Extrapolation engine for static layer & volume setup. More...

#include <StaticEngine.h>

Inheritance diagram for Trk::StaticEngine:

Collaboration diagram for Trk::StaticEngine:

Public Types
enum	ResolveLayerType {   StartLayer = 0 , NavigationLayer = 1 , PassThroughLayer = 2 , SubStructureLayer = 3 ,   DestinationLayer = 4 , StartAndDestinationLayer = 6 , UndefinedLayer = 5 }

Public Member Functions
	StaticEngine (const std::string &, const std::string &, const IInterface *)
	Constructor.
virtual	~StaticEngine ()
	Destructor.
virtual StatusCode	initialize () override
	AlgTool initialize method.
virtual StatusCode	finalize () override
	AlgTool finalize method.
virtual ExtrapolationCode	extrapolate (ExCellCharged &ecCharged, const Surface *sf=0, const BoundaryCheck &bcheck=true) const override
	charged extrapolation - public interface
virtual ExtrapolationCode	extrapolate (ExCellNeutral &ecNeutral, const Surface *sf=0, const BoundaryCheck &bcheck=true) const override
	neutral extrapolation - public interface
virtual GeometryType	geometryType () const override
	define for which GeometrySignature this extrapolator is valid - this is GLOBAL
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
std::string	m_sopPrefix
	< SCREEN output formatting (SOP) - unify amongst extrapolation engines
std::string	m_sopPostfix
	prefix for screen output

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
template<class T>
ExtrapolationCode	extrapolateT (ExtrapolationCell< T > &eCell, const Surface *sf=0, PropDirection dir=alongMomentum, const BoundaryCheck &bcheck=true) const
	main loop extrapolation method
template<class T>
ExtrapolationCode	initNavigationT (ExtrapolationCell< T > &eCell, const Surface *sf=0, PropDirection dir=alongMomentum, BoundaryCheck bcheck=true) const
	init Navigation for static setup
template<class T>
ExtrapolationCode	handleLayerT (ExtrapolationCell< T > &eCell, const Surface *sf=0, PropDirection dir=alongMomentum, BoundaryCheck bcheck=true) const
	main static layer handling
template<class T>
ExtrapolationCode	resolveLayerT (ExtrapolationCell< T > &eCell, const Trk::Surface *sf, PropDirection dir=alongMomentum, BoundaryCheck bcheck=true, bool hasSubStructure=false, bool isStartLayer=false, bool isDestinationLayer=false) const
	main sub structure layer handling
template<class T>
ExtrapolationCode	handleReturnT (ExtrapolationCode eCode, ExtrapolationCell< T > &eCell, const Surface *sf=0, PropDirection dir=alongMomentum, BoundaryCheck bcheck=true) const
	handle the failure - as configured
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IPropagationEngine >	m_propagationEngine {this, "PropagationEngine", "Trk::PropagationEngine/AtlasStaticPropagation"}
	the used propagation engine
ToolHandle< INavigationEngine >	m_navigationEngine {this, "NavigationEngine", "Trk::StaticNavigationEngine/AtlasStaticNavigation"}
	the navigation engine to resolve the boundary
ToolHandle< IMaterialEffectsEngine >	m_materialEffectsEngine {this, "MaterialEffectsEngine", "Trk::MaterialEffectsEngine/AtlasStaticNavigationMaterialEffects"}
	the material effects updated
StringProperty	m_sopPrefix_prop {this, "OutputPrefix", ""}
StringProperty	m_sopPostfix_prop {this, "OutputPostfix", ""}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Extrapolation engine for static layer & volume setup.

This engine relies on the fact that every position in a static layer setup can be uniquely associated to a layer (NavigationLayer or real physical layer), and thus to a voume at navigation level. The extrapolation process within a fully static setup is then realised as a step from layer to layer within a volume, and from volume to volume at a higher level.

The entire code is written as a template in either charged or neutral parameters.

Author

Andreas.Salzburger -at- cern.ch

Definition at line 49 of file StaticEngine.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

ResolveLayerType

enum Trk::StaticEngine::ResolveLayerType

• use for code readability

Enumerator
StartLayer
NavigationLayer
PassThroughLayer
SubStructureLayer
DestinationLayer
StartAndDestinationLayer
UndefinedLayer

Definition at line 56 of file StaticEngine.h.

                              {
          StartLayer                = 0,
          NavigationLayer           = 1,
          PassThroughLayer          = 2,
          SubStructureLayer         = 3,
          DestinationLayer          = 4,
          StartAndDestinationLayer  = 6,
          UndefinedLayer            = 5
        };          

Constructor & Destructor Documentation

StaticEngine()

Trk::StaticEngine::StaticEngine	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Constructor.

Definition at line 15 of file StaticEngine.cxx.

: AthAlgTool(t,n,p)
{
    declareInterface<Trk::IExtrapolationEngine>(this);
}

~StaticEngine()

Trk::StaticEngine::~StaticEngine ( )

virtualdefault

Destructor.

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extrapolate() [1/2]

Trk::ExtrapolationCode Trk::StaticEngine::extrapolate ( ExCellCharged & ecCharged, const Surface * sf = 0, const BoundaryCheck & bcheck = true ) const

overridevirtual

charged extrapolation - public interface

charged extrapolation

Implements Trk::IExtrapolationEngine.

Definition at line 63 of file StaticEngine.cxx.

{ return extrapolateT<TrackParameters>(ecCharged,sf,ecCharged.propDirection,bcheck); }

extrapolate() [2/2]

Trk::ExtrapolationCode Trk::StaticEngine::extrapolate ( ExCellNeutral & ecNeutral, const Surface * sf = 0, const BoundaryCheck & bcheck = true ) const

overridevirtual

neutral extrapolation - public interface

neutral extrapolation

Implements Trk::IExtrapolationEngine.

Definition at line 70 of file StaticEngine.cxx.

{ return extrapolateT<NeutralParameters>(ecNeutral,sf,ecNeutral.propDirection,bcheck); }

extrapolateT()

template<class T>

ExtrapolationCode Trk::StaticEngine::extrapolateT ( ExtrapolationCell< T > & eCell, const Surface * sf = 0, PropDirection dir = alongMomentum, const BoundaryCheck & bcheck = true ) const

private

main loop extrapolation method

finalize()

StatusCode Trk::StaticEngine::finalize ( )

overridevirtual

AlgTool finalize method.

Definition at line 55 of file StaticEngine.cxx.

{    
    EX_MSG_DEBUG("", "finalize", "", "successful." );
    return StatusCode::SUCCESS;
}

geometryType()

GeometryType Trk::StaticEngine::geometryType ( ) const

inlineoverridevirtual

define for which GeometrySignature this extrapolator is valid - this is GLOBAL

Implements Trk::IExtrapolationEngine.

Definition at line 137 of file StaticEngine.h.

      { return Trk::Static; }

handleLayerT()

template<class T>

ExtrapolationCode Trk::StaticEngine::handleLayerT ( ExtrapolationCell< T > & eCell, const Surface * sf = 0, PropDirection dir = alongMomentum, BoundaryCheck bcheck = true ) const

private

main static layer handling

handleReturnT()

template<class T>

ExtrapolationCode Trk::StaticEngine::handleReturnT ( ExtrapolationCode eCode, ExtrapolationCell< T > & eCell, const Surface * sf = 0, PropDirection dir = alongMomentum, BoundaryCheck bcheck = true ) const

private

handle the failure - as configured

initialize()

StatusCode Trk::StaticEngine::initialize ( )

overridevirtual

AlgTool initialize method.

Definition at line 27 of file StaticEngine.cxx.

{
    m_sopPrefix = m_sopPrefix_prop;
    m_sopPostfix = m_sopPostfix_prop;
 
    if (m_propagationEngine.retrieve().isFailure()){
        EX_MSG_FATAL("", "initialize", "", "failed to retrieve propagation engine '"<< m_propagationEngine << "'. Aborting." );
        return StatusCode::FAILURE;
    } else 
        EX_MSG_DEBUG("", "initialize", "", "successfully  propagation engine '" << m_propagationEngine << "'." );
    
    if (m_navigationEngine.retrieve().isFailure()){
        EX_MSG_FATAL("", "initialize", "", "failed to retrieve navigation engine '"<< m_navigationEngine << "'. Aborting." );
        return StatusCode::FAILURE;
    } else 
        EX_MSG_DEBUG("", "initialize", "", "successfully retrieved '" << m_navigationEngine << "'." );
            
    if (m_materialEffectsEngine.retrieve().isFailure()){
        EX_MSG_FATAL("", "initialize", "", "failed to retrieve material effect engine '"<< m_materialEffectsEngine << "'. Aborting." );
        return StatusCode::FAILURE;
    } else 
        EX_MSG_DEBUG("", "initialize", "", "successfully retrieved '" << m_materialEffectsEngine << "'." );
    
    EX_MSG_DEBUG("", "initialize", "", "successful." );
    return StatusCode::SUCCESS;
}    

initNavigationT()

template<class T>

ExtrapolationCode Trk::StaticEngine::initNavigationT ( ExtrapolationCell< T > & eCell, const Surface * sf = 0, PropDirection dir = alongMomentum, BoundaryCheck bcheck = true ) const

private

init Navigation for static setup

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & Trk::IExtrapolationEngine::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 43 of file IExtrapolationEngine.h.

{ return IID_IExtrapolationEngine; }

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

resolveLayerT()

template<class T>

ExtrapolationCode Trk::StaticEngine::resolveLayerT ( ExtrapolationCell< T > & eCell, const Trk::Surface * sf, PropDirection dir = alongMomentum, BoundaryCheck bcheck = true, bool hasSubStructure = false, bool isStartLayer = false, bool isDestinationLayer = false ) const

private

main sub structure layer handling

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_materialEffectsEngine

ToolHandle<IMaterialEffectsEngine> Trk::StaticEngine::m_materialEffectsEngine {this, "MaterialEffectsEngine", "Trk::MaterialEffectsEngine/AtlasStaticNavigationMaterialEffects"}

private

the material effects updated

Definition at line 130 of file StaticEngine.h.

{this, "MaterialEffectsEngine", "Trk::MaterialEffectsEngine/AtlasStaticNavigationMaterialEffects"};    

m_navigationEngine

ToolHandle<INavigationEngine> Trk::StaticEngine::m_navigationEngine {this, "NavigationEngine", "Trk::StaticNavigationEngine/AtlasStaticNavigation"}

private

the navigation engine to resolve the boundary

Definition at line 129 of file StaticEngine.h.

{this, "NavigationEngine", "Trk::StaticNavigationEngine/AtlasStaticNavigation"};         

m_propagationEngine

ToolHandle<IPropagationEngine> Trk::StaticEngine::m_propagationEngine {this, "PropagationEngine", "Trk::PropagationEngine/AtlasStaticPropagation"}

private

the used propagation engine

Definition at line 128 of file StaticEngine.h.

{this, "PropagationEngine", "Trk::PropagationEngine/AtlasStaticPropagation"};        

m_sopPostfix

std::string Trk::IExtrapolationEngine::m_sopPostfix

protectedinherited

prefix for screen output

Definition at line 64 of file IExtrapolationEngine.h.

m_sopPostfix_prop

StringProperty Trk::StaticEngine::m_sopPostfix_prop {this, "OutputPostfix", ""}

private

Definition at line 133 of file StaticEngine.h.

{this, "OutputPostfix", ""};

m_sopPrefix

std::string Trk::IExtrapolationEngine::m_sopPrefix

protectedinherited

< SCREEN output formatting (SOP) - unify amongst extrapolation engines

prefix for screen output

Definition at line 63 of file IExtrapolationEngine.h.

m_sopPrefix_prop

StringProperty Trk::StaticEngine::m_sopPrefix_prop {this, "OutputPrefix", ""}

private

Definition at line 132 of file StaticEngine.h.

{this, "OutputPrefix", ""};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• StaticEngine.h
• StaticEngine.cxx