ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::VolumeCollector< Selector > Struct Template Reference

A Volume Collector struct templated with a Selector type. More...

#include <Acts/Propagator/VolumeCollector.hpp>

Collaboration diagram for Acts::VolumeCollector< Selector >:
[legend]

Classes

struct  this_result
 Simple result struct to be returned It has all the VolumeHit objects that are collected (and thus have been selected). More...

Public Types

using result_type = this_result
 Type alias for collector result type.

Public Member Functions

template<typename propagator_state_t, typename stepper_t, typename navigator_t>
Result< void > act (propagator_state_t &state, const stepper_t &stepper, const navigator_t &navigator, result_type &result, const Logger &logger) const
 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:

Public Attributes

Selector selector
 The selector used for this volume.

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.

Member Typedef Documentation

◆ result_type

template<typename Selector = VolumeSelector>
using Acts::VolumeCollector< Selector >::result_type = this_result

Type alias for collector result type.

Member Function Documentation

◆ act()

template<typename Selector = VolumeSelector>
template<typename propagator_state_t, typename stepper_t, typename navigator_t>
Result< void > Acts::VolumeCollector< Selector >::act ( propagator_state_t & state,
const stepper_t & stepper,
const navigator_t & navigator,
result_type & result,
const Logger & logger ) const

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_tis the type of Propagator state
stepper_tType of the stepper used for the propagation
navigator_tType of the navigator used for the propagation
Parameters
[in,out]stateis the mutable stepper state object
[in]stepperThe stepper in use
[in]navigatorThe navigator in use
[in,out]resultis the mutable result object
loggerthe logger object

Member Data Documentation

◆ selector

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

The selector used for this volume.