ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t > Struct Template Reference

Options for propagate() call. More...

#include <Acts/Propagator/PropagatorOptions.hpp>

Inheritance diagram for Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >:
[legend]
Collaboration diagram for Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >:
[legend]

Public Types

using actor_list_type = actor_list_t
 Type alias for actor list.
using navigator_options_type = navigator_options_t
 Type alias for navigator options.
using stepper_options_type = stepper_options_t
 Type alias for stepper options.

Public Member Functions

 PropagatorOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx)
 PropagatorOptions with context.
 PropagatorOptions (const PropagatorPlainOptions &pOptions)
 PropagatorOptions with context and plain options.
template<typename extended_actor_list_t>
PropagatorOptions< stepper_options_t, navigator_options_t, extended_actor_list_t > extend (extended_actor_list_t extendedActorList) const
 Expand the options with extended actors.
 operator PropagatorPlainOptions () const
 Convert to plain options.
void setPlainOptions (const PropagatorPlainOptions &pOptions)
 Set the plain options.

Public Attributes

actor_list_t actorList
 List of actions.
std::reference_wrapper< const GeometryContextgeoContext
 The context object for the geometry.
std::reference_wrapper< const MagneticFieldContextmagFieldContext
 The context object for the magnetic field.
navigator_options_t navigation
 Navigator options.
stepper_options_t stepping
 Stepper options.

Detailed Description

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>
struct Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >

Options for propagate() call.

Template Parameters
actor_list_tList of action types called after each propagation step with the current propagation and stepper state

Constructor & Destructor Documentation

◆ PropagatorOptions() [1/2]

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>
Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::PropagatorOptions ( const GeometryContext & gctx,
const MagneticFieldContext & mctx )

PropagatorOptions with context.

Parameters
gctxGeometry context for propagation
mctxMagnetic field context for propagation

◆ PropagatorOptions() [2/2]

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>
Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::PropagatorOptions ( const PropagatorPlainOptions & pOptions)
explicit

PropagatorOptions with context and plain options.

Parameters
pOptionsPlain options to initialize from

Member Function Documentation

◆ extend()

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>
template<typename extended_actor_list_t>
PropagatorOptions< stepper_options_t, navigator_options_t, extended_actor_list_t > Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::extend ( extended_actor_list_t extendedActorList) const

Expand the options with extended actors.

Template Parameters
extended_actor_list_tType of the new actor list
Parameters
extendedActorListThe new actor list to be used (internally)
Returns
PropagatorOptions with the extended actor list

◆ setPlainOptions()

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>
void Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::setPlainOptions ( const PropagatorPlainOptions & pOptions)

Set the plain options.

Parameters
pOptionsThe plain options