Acts::VolumeCollector< Selector > Struct Template Reference

#include <acts/blob/master/Core/include/Acts/Propagator/VolumeCollector.hpp>

Classes
struct	this_result

Public Types
using	result_type = this_result

Public Member Functions
template<typename propagator_state_t , typename stepper_t >
void	operator() (propagator_state_t &state, const stepper_t &stepper, result_type &result) const
template<typename propagator_state_t , typename stepper_t >
void	operator() (propagator_state_t &, const stepper_t &) const

Public Attributes
Selector	selector
	The selector used for this volume.

Private Member Functions
template<typename propagator_state_t >
void	debugLog (propagator_state_t &state, const std::function< std::string()> &logAction) const

Detailed Description

template<typename Selector = VolumeSelector>
struct Acts::VolumeCollector< Selector >

A Volume Collector struct templated with a Selector type

Whenever a volume is passed in the propagation that satisfies the selector, it is recorded for further usage in the flow.

Definition at line 64 of file VolumeCollector.hpp.

View newest version in sPHENIX GitHub at line 64 of file VolumeCollector.hpp

Member Typedef Documentation

template<typename Selector = VolumeSelector>

using Acts::VolumeCollector< Selector >::result_type = this_result

Definition at line 75 of file VolumeCollector.hpp.

View newest version in sPHENIX GitHub at line 75 of file VolumeCollector.hpp

Member Function Documentation

template<typename Selector = VolumeSelector>

template<typename propagator_state_t >

void Acts::VolumeCollector< Selector >::debugLog ( propagator_state_t &  state, const std::function< std::string()> &  logAction  ) const

inlineprivate

The private propagation debug logging

It needs to be fed by a lambda function that returns a string, that guarantees that the lambda is only called in the state.debug == true case in order not to spend time when not needed.

Template Parameters

propagator_state_t

Type of the propagator state

Parameters

state	the propagator state for the debug flag, prefix and length
logAction	is a callable function that returns a streamable object

Definition at line 130 of file VolumeCollector.hpp.

View newest version in sPHENIX GitHub at line 130 of file VolumeCollector.hpp

Referenced by Acts::VolumeCollector< Selector >::operator()().

Here is the caller graph for this function:

template<typename Selector = VolumeSelector>

template<typename propagator_state_t , typename stepper_t >

void Acts::VolumeCollector< Selector >::operator() ( propagator_state_t &  state, const stepper_t &  stepper, result_type &  result  ) const

inline

Collector action for the ActionList of the Propagator It checks if the propagator state has a current volume, in which case the action is performed:

• it records the volume given the configuration

Template Parameters

propagator_state_t	is the type of Propagator state
stepper_t	Type of the stepper used for the propagation

Parameters

[in,out]	state	is the mutable stepper state object
[in]	stepper	The stepper in use
[in,out]	result	is the mutable result object

Definition at line 89 of file VolumeCollector.hpp.

View newest version in sPHENIX GitHub at line 89 of file VolumeCollector.hpp

References Acts::VolumeCollector< Selector >::this_result::collected, Acts::VolumeCollector< Selector >::debugLog(), Acts::VolumeHit::direction, Acts::VolumeHit::position, Acts::VolumeCollector< Selector >::selector, and Acts::VolumeHit::volume.

Here is the call graph for this function:

template<typename Selector = VolumeSelector>

template<typename propagator_state_t , typename stepper_t >

void Acts::VolumeCollector< Selector >::operator() ( propagator_state_t &  , const stepper_t &    ) const

inline

Pure observer interface

• this does not apply to the volume collector

Definition at line 114 of file VolumeCollector.hpp.

View newest version in sPHENIX GitHub at line 114 of file VolumeCollector.hpp

Member Data Documentation

template<typename Selector = VolumeSelector>

Selector Acts::VolumeCollector< Selector >::selector

The selector used for this volume.

Definition at line 66 of file VolumeCollector.hpp.

View newest version in sPHENIX GitHub at line 66 of file VolumeCollector.hpp

Referenced by Acts::VolumeCollector< Selector >::operator()().

---

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

• acts/blob/master/Core/include/Acts/Propagator/VolumeCollector.hpp