Acts::IndexGridNavigationPolicy< GridType > Class Template Reference

A navigation policy that uses grid based navigation for indexed surfaces Navigate through a multilayer structure by creating an artificial path on the grid. More...

#include <Acts/Navigation/IndexGridNavigationPolicy.hpp>

Inheritance diagram for Acts::IndexGridNavigationPolicy< GridType >:

Collaboration diagram for Acts::IndexGridNavigationPolicy< GridType >:

Public Types
using	IndexGridType = IndexGrid<GridType>
	Index grid type.

Public Member Functions
	IndexGridNavigationPolicy (const GeometryContext &gctx, const TrackingVolume &volume, const Logger &logger, const IndexGridNavigationConfig &config, const IndexGridType &grid)
	Main constructor, which expects the grid and will fill it with the surfaces from the volume passed.
void	connect (NavigationDelegate &delegate) const override
	Connect this policy with a navigation delegate.
const IndexGridType &	indexGrid () const
	Give const access to the index grid.
void	initializeCandidates (const GeometryContext &gctx, const NavigationArguments &args, NavigationPolicyState &state, AppendOnlyNavigationStream &stream, const Logger &logger) const
	Update the navigation state from the surface array.
Public Member Functions inherited from Acts::INavigationPolicy
virtual	~INavigationPolicy ()=default
	Virtual destructor so policies can be held through this base class.
virtual void	createState (const GeometryContext &gctx, const NavigationArguments &args, NavigationPolicyStateManager &stateManager, const Logger &logger) const
	Create and initialize the state for this policy.
void	initializeStatelessCache (const GeometryContext &gctx, const Logger &logger=getDummyLogger())
	One-time initialization step that probes whether this policy pushes only default (empty) states and caches the result (mutating internal state), allowing the navigator to skip the per-volume-entry state creation and the matching pop entirely for volumes with such policies.
bool	isStateless () const
	Whether this policy is known to push only default (empty) states, see initializeStatelessCache.
virtual bool	isValid (const GeometryContext &gctx, const NavigationArguments &args, NavigationPolicyState &state, const Logger &logger) const
	Check if the policy is in a valid state for navigation.
virtual void	popState (NavigationPolicyStateManager &stateManager, const Logger &logger) const
	Remove the state for this policy from the state manager.
virtual void	visit (const std::function< void(const INavigationPolicy &)> &visitor) const
	Convenience function to walk over all navigation policies.

Additional Inherited Members
Static Public Member Functions inherited from Acts::INavigationPolicy
static void	noopInitializeCandidates (const GeometryContext &, const NavigationArguments &, NavigationPolicyState &, const AppendOnlyNavigationStream &, const Logger &)
	Noop update function that is suitable as a default for default navigation delegates.
Protected Member Functions inherited from Acts::INavigationPolicy
template<NavigationPolicyConcept T>
void	connectDefault (NavigationDelegate &delegate) const
	Internal helper function for derived classes that conform to the concept and have a conventional updateState method.

Detailed Description

template<typename GridType>
class Acts::IndexGridNavigationPolicy< GridType >

A navigation policy that uses grid based navigation for indexed surfaces Navigate through a multilayer structure by creating an artificial path on the grid.

Constructor & Destructor Documentation

IndexGridNavigationPolicy()

template<typename GridType>

Acts::IndexGridNavigationPolicy< GridType >::IndexGridNavigationPolicy ( const GeometryContext & gctx, const TrackingVolume & volume, const Logger & logger, const IndexGridNavigationConfig & config, const IndexGridType & grid )

explicit

Main constructor, which expects the grid and will fill it with the surfaces from the volume passed.

Note

Expects that the grid is defined but not filled - it will be filled here with the surfaces assigned to the volume

Parameters

gctx	The geometrycontext object
volume	The tracking volume holding the surfaces that will be the indexed objects
logger	A logging instance
config	The configuration of the Navigation Policy
grid	The index grid to use for navigation

Member Function Documentation

connect()

template<typename GridType>

void Acts::IndexGridNavigationPolicy< GridType >::connect ( NavigationDelegate & delegate ) const

overridevirtual

Connect this policy with a navigation delegate.

Parameters

delegate

The navigation delegate to connect to

Implements Acts::INavigationPolicy.

indexGrid()

template<typename GridType>

const IndexGridType & Acts::IndexGridNavigationPolicy< GridType >::indexGrid

(

)

const

Give const access to the index grid.

Returns

initializeCandidates()

template<typename GridType>

void Acts::IndexGridNavigationPolicy< GridType >::initializeCandidates	(	const GeometryContext &	gctx,
		const NavigationArguments &	args,
		NavigationPolicyState &	state,
		AppendOnlyNavigationStream &	stream,
		const Logger &	logger ) const

Update the navigation state from the surface array.

Parameters

gctx	the geometry context
args	The navigation arguments
state	The navigation policy state
stream	The navigation stream to update
logger	The logger