ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t > Struct Template Reference

private Propagator state for navigation and debugging More...

#include <Acts/Propagator/PropagatorState.hpp>

Inheritance diagram for Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >:
[legend]
Collaboration diagram for Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >:
[legend]

Public Types

using navigator_state_type = navigator_state_t
 Type alias for navigator state.
using options_type = propagator_options_t
 Type alias for propagator options.
using stepper_state_type = stepper_state_t
 Type alias for stepper state.

Public Member Functions

 PropagatorState (const propagator_options_t &topts, stepper_state_t steppingIn, navigator_state_t navigationIn)
 Create the propagator state from the options.

Public Attributes

Vector3 direction = Vector3::Zero()
 The direction of the propagation.
std::reference_wrapper< const GeometryContextgeoContext
 Context object for the geometry.
navigator_state_t navigation
 Navigation state - internal state of the Navigator.
propagator_options_t options
 These are the options - provided for each propagation step.
double pathLength = 0.
 Signed distance over which the parameters were propagated.
Vector3 position = Vector3::Zero()
 The position of the propagation.
PropagatorStage stage = PropagatorStage::invalid
 Propagation stage.
PropagatorStatistics statistics
 Statistics of the propagation.
stepper_state_t stepping
 Stepper state - internal state of the Stepper.
std::size_t steps = 0
 Number of propagation steps that were carried out.

Detailed Description

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
struct Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >

private Propagator state for navigation and debugging

Template Parameters
propagator_options_tType of the Objections object

This struct holds the common state information for propagating which is independent of the actual stepper implementation.

Member Typedef Documentation

◆ navigator_state_type

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
using Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::navigator_state_type = navigator_state_t

Type alias for navigator state.

◆ options_type

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
using Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::options_type = propagator_options_t

Type alias for propagator options.

◆ stepper_state_type

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
using Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::stepper_state_type = stepper_state_t

Type alias for stepper state.

Constructor & Destructor Documentation

◆ PropagatorState()

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::PropagatorState ( const propagator_options_t & topts,
stepper_state_t steppingIn,
navigator_state_t navigationIn )

Create the propagator state from the options.

Template Parameters
propagator_options_tthe type of the propagator options
Parameters
toptsThe options handed over by the propagate call
steppingInStepper state instance to begin with
navigationInNavigator state instance to begin with

Member Data Documentation

◆ direction

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
Vector3 Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::direction = Vector3::Zero()

The direction of the propagation.

◆ geoContext

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
std::reference_wrapper<const GeometryContext> Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::geoContext

Context object for the geometry.

◆ navigation

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
navigator_state_t Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::navigation

Navigation state - internal state of the Navigator.

◆ options

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
propagator_options_t Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::options

These are the options - provided for each propagation step.

◆ pathLength

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
double Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::pathLength = 0.

Signed distance over which the parameters were propagated.

◆ position

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
Vector3 Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::position = Vector3::Zero()

The position of the propagation.

◆ stage

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
PropagatorStage Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::stage = PropagatorStage::invalid

Propagation stage.

◆ statistics

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
PropagatorStatistics Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::statistics

Statistics of the propagation.

◆ stepping

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
stepper_state_t Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::stepping

Stepper state - internal state of the Stepper.

◆ steps

template<typename propagator_options_t, typename stepper_state_t, typename navigator_state_t, typename... extension_state_t>
std::size_t Acts::PropagatorState< propagator_options_t, stepper_state_t, navigator_state_t, extension_state_t >::steps = 0

Number of propagation steps that were carried out.