#include <StaticNavigationEngine.h>

Inheritance diagram for Trk::StaticNavigationEngine:

Collaboration diagram for Trk::StaticNavigationEngine:

Public Member Functions
	StaticNavigationEngine (const std::string &, const std::string &, const IInterface *)
	Constructor.
	~StaticNavigationEngine ()
	Destructor.
StatusCode	initialize ()
	AlgTool initialize method.
StatusCode	finalize ()
	AlgTool finalize method.
virtual ExtrapolationCode	resolveBoundary (Trk::ExCellCharged &eCell, PropDirection dir=alongMomentum) const
	resolve the boundary situation - for charged particles
virtual ExtrapolationCode	resolveBoundary (Trk::ExCellNeutral &eCelll, PropDirection dir=alongMomentum) const
	resolve the boundary situation - for neutral particles
virtual ExtrapolationCode	resolvePosition (Trk::ExCellCharged &eCell, PropDirection dir=alongMomentum, bool noLoop=false) const
	resolve the boundary situation - for charged particles
virtual ExtrapolationCode	resolvePosition (Trk::ExCellNeutral &eCelll, PropDirection dir=alongMomentum, bool noLoop=false) const
	resolve the boundary situation - for neutral particles
virtual const TrackingGeometry &	trackingGeometry () const
	acces to tracking geometry
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	resolveBoundaryT (ExtrapolationCell< T > &eCell, PropDirection dir=alongMomentum) const
	resolve the boundary situation
template<class T>
ExtrapolationCode	resolvePositionT (ExtrapolationCell< T > &eCell, PropDirection dir=alongMomentum, bool noLoop=false) const
	resolve position
template<class T>
ExtrapolationCode	handleBoundaryT (ExtrapolationCell< T > &eCell, const BoundarySurface< TrackingVolume > &bSurfaceTV, PropDirection dir=alongMomentum, bool stepout=false) const
	deal with the boundary Surface - called by resolveBoundary
void	throwFailedToGetTrackingGeomtry () const
const TrackingGeometry *	retrieveTrackingGeometry (const EventContext &ctx) const
StatusCode	updateTrackingGeometry () const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StringProperty	m_sopPrefix_prop {this, "OutputPrefix", ""}
StringProperty	m_sopPostfix_prop {this, "OutputPostfix", ""}
SG::ReadCondHandleKey< TrackingGeometry >	m_trackingGeometryReadKey {this, "TrackingGeometryReadKey", "", "Key of the TrackingGeometry conditions data."}
	retrieve TrackingGeometry
ToolHandle< IPropagationEngine >	m_propagationEngine {this, "PropagationEngine", "Trk::PropagationEngine/AtlasStaticPropagation"}
	the used propagation engine
ToolHandle< IMaterialEffectsEngine >	m_materialEffectsEngine {this, "MaterialEffectsEngine", "Trk::MaterialEffectsEngine/AtlasStaticNavigationMaterialEffects"}
	the material effects updated
std::string	m_trackingGeometryName
	Name of the TrackingGeometry as given in Detector Store.
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

Definition at line 43 of file StaticNavigationEngine.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ StaticNavigationEngine()

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

Constructor.

Definition at line 15 of file StaticNavigationEngine.cxx.

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

◆ ~StaticNavigationEngine()

Trk::StaticNavigationEngine::~StaticNavigationEngine ( )

default

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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ finalize()

StatusCode Trk::StaticNavigationEngine::finalize ( )

AlgTool finalize method.

Definition at line 40 of file StaticNavigationEngine.cxx.

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

◆ handleBoundaryT()

template<class T>

ExtrapolationCode Trk::StaticNavigationEngine::handleBoundaryT	(	ExtrapolationCell< T > &	eCell,
		const BoundarySurface< TrackingVolume > &	bSurfaceTV,
		PropDirection	dir = alongMomentum,
		bool	stepout = false ) const

private

deal with the boundary Surface - called by resolveBoundary

◆ initialize()

StatusCode Trk::StaticNavigationEngine::initialize ( )

AlgTool initialize method.

Definition at line 26 of file StaticNavigationEngine.cxx.

{
    m_sopPrefix = m_sopPrefix_prop;
    m_sopPostfix = m_sopPostfix_prop;
    
    ATH_CHECK( m_trackingGeometryReadKey.initialize(!m_trackingGeometryReadKey.key().empty()) );
    ATH_CHECK( m_propagationEngine.retrieve());
    ATH_CHECK( m_materialEffectsEngine.retrieve());
 
    EX_MSG_DEBUG("", "initialize", "", "successful" );
    return StatusCode::SUCCESS;
}    

◆ 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::INavigationEngine::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 45 of file INavigationEngine.h.

45{ return IID_INavigationEngine; }

Trk::IID_INavigationEngine

static const InterfaceID IID_INavigationEngine("INavigationEngine", 1, 0)

◆ 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();
  }

◆ resolveBoundary() [1/2]

Trk::ExtrapolationCode Trk::StaticNavigationEngine::resolveBoundary	(	Trk::ExCellCharged &	eCell,
		PropDirection	dir = alongMomentum ) const

virtual

resolve the boundary situation - for charged particles

charged situation

Implements Trk::INavigationEngine.

Definition at line 47 of file StaticNavigationEngine.cxx.

48{ return resolveBoundaryT<Trk::TrackParameters>(ecCharged,dir); }

Trk::StaticNavigationEngine::resolveBoundaryT

ExtrapolationCode resolveBoundaryT(ExtrapolationCell< T > &eCell, PropDirection dir=alongMomentum) const

resolve the boundary situation

◆ resolveBoundary() [2/2]

Trk::ExtrapolationCode Trk::StaticNavigationEngine::resolveBoundary	(	Trk::ExCellNeutral &	eCelll,
		PropDirection	dir = alongMomentum ) const

virtual

resolve the boundary situation - for neutral particles

charged situation

Implements Trk::INavigationEngine.

Definition at line 51 of file StaticNavigationEngine.cxx.

52{ return resolveBoundaryT<Trk::NeutralParameters>(ecNeutral,dir); }

◆ resolveBoundaryT()

template<class T>

ExtrapolationCode Trk::StaticNavigationEngine::resolveBoundaryT	(	ExtrapolationCell< T > &	eCell,
		PropDirection	dir = alongMomentum ) const

private

resolve the boundary situation

◆ resolvePosition() [1/2]

Trk::ExtrapolationCode Trk::StaticNavigationEngine::resolvePosition	(	Trk::ExCellCharged &	eCell,
		PropDirection	dir = alongMomentum,
		bool	noLoop = false ) const

virtual

resolve the boundary situation - for charged particles

charged

Implements Trk::INavigationEngine.

Definition at line 55 of file StaticNavigationEngine.cxx.

56{ return resolvePositionT<Trk::TrackParameters>(ecCharged,dir, noLoop); }

Trk::StaticNavigationEngine::resolvePositionT

ExtrapolationCode resolvePositionT(ExtrapolationCell< T > &eCell, PropDirection dir=alongMomentum, bool noLoop=false) const

resolve position

◆ resolvePosition() [2/2]

Trk::ExtrapolationCode Trk::StaticNavigationEngine::resolvePosition	(	Trk::ExCellNeutral &	eCelll,
		PropDirection	dir = alongMomentum,
		bool	noLoop = false ) const

virtual

resolve the boundary situation - for neutral particles

neutral

Implements Trk::INavigationEngine.

Definition at line 59 of file StaticNavigationEngine.cxx.

60{ return resolvePositionT<Trk::NeutralParameters>(ecNeutral,dir, noLoop); }

◆ resolvePositionT()

template<class T>

ExtrapolationCode Trk::StaticNavigationEngine::resolvePositionT	(	ExtrapolationCell< T > &	eCell,
		PropDirection	dir = alongMomentum,
		bool	noLoop = false ) const

private

resolve position

◆ retrieveTrackingGeometry()

const TrackingGeometry * Trk::StaticNavigationEngine::retrieveTrackingGeometry ( const EventContext & ctx ) const

inlineprivate

Definition at line 99 of file StaticNavigationEngine.h.

                                                                                        {
          SG::ReadCondHandle<TrackingGeometry>  handle(m_trackingGeometryReadKey,ctx);
           if (!handle.isValid()) {
              EX_MSG_FATAL("", "updateGeo", "", "Could not load TrackingGeometry with name '" << m_trackingGeometryReadKey.key() << "'. Aborting." );
              throwFailedToGetTrackingGeomtry();
           }
           return handle.cptr();
        }

◆ 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.

◆ throwFailedToGetTrackingGeomtry()

void Trk::StaticNavigationEngine::throwFailedToGetTrackingGeomtry ( ) const

private

Definition at line 62 of file StaticNavigationEngine.cxx.

                                                                      {
   std::stringstream msg;
   msg << "Failed to get conditions data " << m_trackingGeometryReadKey.key() << ".";
   throw std::runtime_error(msg.str());
}

◆ trackingGeometry()

const Trk::TrackingGeometry & Trk::StaticNavigationEngine::trackingGeometry ( ) const

inlinevirtual

acces to tracking geometry

Implements Trk::INavigationEngine.

Definition at line 121 of file StaticNavigationEngine.h.

                                                                                     {
       const Trk::TrackingGeometry *tracking_geometry = retrieveTrackingGeometry(Gaudi::Hive::currentContext());
       if (!tracking_geometry){
          EX_MSG_FATAL("", "updateGeo", "", "Did not get valid TrackingGeometry. Aborting." );
          throw GaudiException("ExtrapolationEngine", "Problem with TrackingGeometry loading.", StatusCode::FAILURE);
       }
       return *tracking_geometry;
    }

◆ updateTrackingGeometry()

StatusCode Trk::StaticNavigationEngine::updateTrackingGeometry ( ) const

private

◆ 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::StaticNavigationEngine::m_materialEffectsEngine {this, "MaterialEffectsEngine", "Trk::MaterialEffectsEngine/AtlasStaticNavigationMaterialEffects"}

private

the material effects updated

Definition at line 115 of file StaticNavigationEngine.h.

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

◆ m_propagationEngine

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

private

the used propagation engine

Definition at line 114 of file StaticNavigationEngine.h.

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

◆ m_sopPostfix

std::string Trk::INavigationEngine::m_sopPostfix

protectedinherited

prefix for screen output

Definition at line 65 of file INavigationEngine.h.

◆ m_sopPostfix_prop

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

private

Definition at line 80 of file StaticNavigationEngine.h.

80{this, "OutputPostfix", ""};

◆ m_sopPrefix

std::string Trk::INavigationEngine::m_sopPrefix

protectedinherited

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

prefix for screen output

Definition at line 64 of file INavigationEngine.h.

◆ m_sopPrefix_prop

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

private

Definition at line 79 of file StaticNavigationEngine.h.

79{this, "OutputPrefix", ""};

◆ m_trackingGeometryName

std::string Trk::StaticNavigationEngine::m_trackingGeometryName

private

Name of the TrackingGeometry as given in Detector Store.

Definition at line 117 of file StaticNavigationEngine.h.

◆ m_trackingGeometryReadKey

SG::ReadCondHandleKey<TrackingGeometry> Trk::StaticNavigationEngine::m_trackingGeometryReadKey {this, "TrackingGeometryReadKey", "", "Key of the TrackingGeometry conditions data."}

private

retrieve TrackingGeometry

Definition at line 108 of file StaticNavigationEngine.h.

109{this, "TrackingGeometryReadKey", "", "Key of the TrackingGeometry conditions data."};

◆ 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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ StaticNavigationEngine()

◆ ~StaticNavigationEngine()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ handleBoundaryT()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ resolveBoundary() [1/2]

◆ resolveBoundary() [2/2]

◆ resolveBoundaryT()

◆ resolvePosition() [1/2]

◆ resolvePosition() [2/2]

◆ resolvePositionT()

◆ retrieveTrackingGeometry()

◆ sysInitialize()

◆ sysStart()

◆ throwFailedToGetTrackingGeomtry()

◆ trackingGeometry()

◆ updateTrackingGeometry()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_materialEffectsEngine

◆ m_propagationEngine

◆ m_sopPostfix

◆ m_sopPostfix_prop

◆ m_sopPrefix

◆ m_sopPrefix_prop

◆ m_trackingGeometryName

◆ m_trackingGeometryReadKey

◆ m_varHandleArraysDeclared

◆ m_vhka