Acts::AbortList< aborters_t > Struct Template Reference

AbortList object to be used in the propagation. More...

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

Inheritance diagram for Acts::AbortList< aborters_t >:

Collaboration diagram for Acts::AbortList< aborters_t >:

Public Types
using	result_type = typename decltype(hana::unpack(detail::type_collector_t< detail::action_type_extractor, aborters_t...>, hana::template_< AbortList >))::type

Public Member Functions
	AbortList ()=default
	Default constructor.
	AbortList (const AbortList< aborters_t...> &aborters)=default
	AbortList (AbortList< aborters_t...> &&aborters)=default
AbortList< aborters_t...> &	operator= (const AbortList< aborters_t...> &aborters)=default
AbortList< aborters_t...> &	operator= (AbortList< aborters_t...> &&aborters)=default
	AbortList (const std::tuple< aborters_t...> &aborters)
	AbortList (std::tuple< aborters_t...> &&aborters)
template<typename... appendices_t>
AbortList< aborters_t..., appendices_t...>	append (appendices_t...aps) const
	Append new entries and return a new condition.
template<typename result_t , typename propagator_state_t , typename stepper_t >
bool	operator() (const result_t &result, propagator_state_t &state, const stepper_t &stepper) const
Public Member Functions inherited from Acts::detail::Extendable< aborters_t...>
	Extendable ()=default
	Default constructor.
	Extendable (const Extendable< extensions_t...> &extendable)=default
	Default copy constructor.
	Extendable (Extendable< extensions_t...> &&extendable)=default
	Extendable (const std::tuple< extensions_t...> &extensions)
	Extendable (std::tuple< extensions_t...> &&extensions)
Extendable< extensions_t...> &	operator= (const Extendable< extensions_t...> &extendable)=default
Extendable< extensions_t...> &	operator= (Extendable< extensions_t...> &&extendable)=default
Extendable< extensions_t..., appendices_t...>	append (appendices_t...aps) const
const extension_t &	get () const
extension_t &	get ()
const std::tuple < extensions_t...> &	tuple () const
std::tuple< extensions_t...> &	tuple ()

Detailed Description

template<typename... aborters_t>
struct Acts::AbortList< aborters_t >

AbortList object to be used in the propagation.

The abort list is a list of structs or classes that is called at each propagation step and can trigger the abort of the current propagation.

It can (optionally) depend on a result of an Actor from the actor list.

Definition at line 33 of file AbortList.hpp.

View newest version in sPHENIX GitHub at line 33 of file AbortList.hpp

Member Typedef Documentation

template<typename... aborters_t>

using Acts::AbortList< aborters_t >::result_type = typename decltype(hana::unpack( detail::type_collector_t<detail::action_type_extractor, aborters_t...>, hana::template_<AbortList>))::type

Definition at line 44 of file AbortList.hpp.

View newest version in sPHENIX GitHub at line 44 of file AbortList.hpp

Constructor & Destructor Documentation

template<typename... aborters_t>

Acts::AbortList< aborters_t >::AbortList ( )

default

Default constructor.

template<typename... aborters_t>

Acts::AbortList< aborters_t >::AbortList ( const AbortList< aborters_t...> &  aborters )

default

Default copy constructor

Parameters

aborters

The source action list

template<typename... aborters_t>

Acts::AbortList< aborters_t >::AbortList ( AbortList< aborters_t...> &&  aborters )

default

Default move constructor

Parameters

aborters

The source action list

template<typename... aborters_t>

Acts::AbortList< aborters_t >::AbortList ( const std::tuple< aborters_t...> &  aborters )

inline

Constructor from tuple

Parameters

extensions

Source extensions tuple

Definition at line 76 of file AbortList.hpp.

View newest version in sPHENIX GitHub at line 76 of file AbortList.hpp

template<typename... aborters_t>

Acts::AbortList< aborters_t >::AbortList ( std::tuple< aborters_t...> &&  aborters )

inline

Constructor from tuple move

Parameters

extensions

Source extensions tuple

Definition at line 82 of file AbortList.hpp.

View newest version in sPHENIX GitHub at line 82 of file AbortList.hpp

Member Function Documentation

template<typename... aborters_t>

template<typename... appendices_t>

AbortList<aborters_t..., appendices_t...> Acts::AbortList< aborters_t >::append ( appendices_t...  aps ) const

inline

Append new entries and return a new condition.

Definition at line 87 of file AbortList.hpp.

View newest version in sPHENIX GitHub at line 87 of file AbortList.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

template<typename... aborters_t>

template<typename result_t , typename propagator_state_t , typename stepper_t >

bool Acts::AbortList< aborters_t >::operator() ( const result_t &  result, propagator_state_t &  state, const stepper_t &  stepper  ) const

inline

This is the call signature for the abort list, it broadcasts the call to the tuple() memembers of the list

Template Parameters

result_t	is the result type from a certain action
propagator_state_t	is the state type of the propagator
stepper_t	Type of the stepper

Parameters

[in]	result	is the result object from a certain action
[in,out]	state	is the state object from the propagator
[in]	stepper	Stepper used for the propagation

Definition at line 104 of file AbortList.hpp.

View newest version in sPHENIX GitHub at line 104 of file AbortList.hpp

template<typename... aborters_t>

AbortList<aborters_t...>& Acts::AbortList< aborters_t >::operator= ( const AbortList< aborters_t...> &  aborters )

default

Default move assignment operator

Parameters

aborters

The source action list

template<typename... aborters_t>

AbortList<aborters_t...>& Acts::AbortList< aborters_t >::operator= ( AbortList< aborters_t...> &&  aborters )

default

Default move assignment operator

Parameters

aborters

The source action list

---

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

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