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

Collaboration diagram for Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >:

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 GeometryContext >	geoContext
	The context object for the geometry.
std::reference_wrapper< const MagneticFieldContext >	magFieldContext
	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_t

List of action types called after each propagation step with the current propagation and stepper state

Member Typedef Documentation

actor_list_type

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

using Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::actor_list_type = actor_list_t

Type alias for actor list.

navigator_options_type

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

using Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::navigator_options_type = navigator_options_t

Type alias for navigator options.

stepper_options_type

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

using Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::stepper_options_type = stepper_options_t

Type alias for stepper options.

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

gctx	Geometry context for propagation
mctx	Magnetic 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

pOptions

Plain 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_t

Type of the new actor list

Parameters

extendedActorList

The new actor list to be used (internally)

Returns

PropagatorOptions with the extended actor list

operator PropagatorPlainOptions()

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 >::operator PropagatorPlainOptions ( ) const

explicit

Convert to plain options.

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

pOptions

The plain options

Member Data Documentation

actorList

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

actor_list_t Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::actorList

List of actions.

geoContext

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

std::reference_wrapper<const GeometryContext> Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::geoContext

The context object for the geometry.

magFieldContext

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

std::reference_wrapper<const MagneticFieldContext> Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::magFieldContext

The context object for the magnetic field.

navigation

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

navigator_options_t Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::navigation

Navigator options.

stepping

template<typename stepper_options_t, typename navigator_options_t, typename actor_list_t = ActorList<>>

stepper_options_t Acts::PropagatorOptions< stepper_options_t, navigator_options_t, actor_list_t >::stepping

Stepper options.