Acts::VoidNavigator Class Reference

A navigator that does nothing. More...

#include <Acts/Propagator/VoidNavigator.hpp>

Classes
struct	Config
	Nested Config struct. More...
struct	Options
	Nested Options struct. More...
struct	State
	Nested State struct. More...

Public Member Functions
bool	checkTargetValid (const State &, const Vector3 &, const Vector3 &) const
	Checks if the current target is valid (always true for void navigator).
const Surface *	currentSurface (const State &) const
	Returns the current surface (always nullptr for void navigator).
const TrackingVolume *	currentVolume (const State &) const
	Returns the current tracking volume (always nullptr for void navigator).
const IVolumeMaterial *	currentVolumeMaterial (const State &) const
	Returns the current volume material (always nullptr for void navigator).
void	handleSurfaceReached (State &, const Vector3 &, const Vector3 &, const Surface &) const
	Handles reaching a surface (does nothing for void navigator).
Result< void >	initialize (State &, const Vector3 &, const Vector3 &, Direction) const
	Initializes the void navigator (always succeeds and does nothing).
State	makeState (const Options &options) const
	Creates a new navigator state for void navigation.
bool	navigationBreak (const State &) const
	Checks if navigation should break (always true for void navigator).
NavigationTarget	nextTarget (State &, const Vector3 &, const Vector3 &) const
	Returns the next navigation target (always None for void navigator).
const Surface *	startSurface (const State &) const
	Returns the start surface (always nullptr for void navigator).
const Surface *	targetSurface (const State &) const
	Returns the target surface (always nullptr for void navigator).

Detailed Description

A navigator that does nothing.

It does not provide any navigation action

Member Function Documentation

checkTargetValid()

bool Acts::VoidNavigator::checkTargetValid	(	const State &	,
		const Vector3 &	,
		const Vector3 &	) const

Checks if the current target is valid (always true for void navigator).

Returns

Always true since there are no targets to invalidate

currentSurface()

const Surface * Acts::VoidNavigator::currentSurface

(

const State &

)

const

Returns the current surface (always nullptr for void navigator).

Returns

Always nullptr since void navigator has no surfaces

currentVolume()

const TrackingVolume * Acts::VoidNavigator::currentVolume

(

const State &

)

const

Returns the current tracking volume (always nullptr for void navigator).

Returns

Always nullptr since void navigator has no volumes

currentVolumeMaterial()

const IVolumeMaterial * Acts::VoidNavigator::currentVolumeMaterial

(

const State &

)

const

Returns the current volume material (always nullptr for void navigator).

Returns

Always nullptr since void navigator has no material

handleSurfaceReached()

void Acts::VoidNavigator::handleSurfaceReached	(	State &	,
		const Vector3 &	,
		const Vector3 &	,
		const Surface &	) const

Handles reaching a surface (does nothing for void navigator).

initialize()

Result< void > Acts::VoidNavigator::initialize ( State & , const Vector3 & , const Vector3 & , Direction  ) const

nodiscard

Initializes the void navigator (always succeeds and does nothing).

Returns

Always successful result since no initialization is needed

makeState()

State Acts::VoidNavigator::makeState

(

const Options &

options

)

const

Creates a new navigator state for void navigation.

Parameters

options

The navigator options

Returns

Initialized void navigator state

navigationBreak()

bool Acts::VoidNavigator::navigationBreak

(

const State &

)

const

Checks if navigation should break (always true for void navigator).

Returns

Always true to immediately stop navigation

nextTarget()

NavigationTarget Acts::VoidNavigator::nextTarget	(	State &	,
		const Vector3 &	,
		const Vector3 &	) const

Returns the next navigation target (always None for void navigator).

Returns

NavigationTarget::None() since there are no targets in void space

startSurface()

const Surface * Acts::VoidNavigator::startSurface

(

const State &

)

const

Returns the start surface (always nullptr for void navigator).

Returns

Always nullptr since void navigator has no surfaces

targetSurface()

const Surface * Acts::VoidNavigator::targetSurface

(

const State &

)

const

Returns the target surface (always nullptr for void navigator).

Returns

Always nullptr since void navigator has no surfaces