Acts::Navigator::State Struct Reference

Nested State struct. More...

#include <Acts/Propagator/Navigator.hpp>

Collaboration diagram for Acts::Navigator::State:

Public Member Functions
	State (const Options &options_)
	Constructor with navigation options.
NavigationTarget &	navBoundary ()
	Get reference to current navigation boundary.
NavigationTarget &	navCandidate ()
	Get reference to current navigation candidate.
NavigationTarget &	navLayer ()
	Get reference to current navigation layer.
NavigationTarget &	navSurface ()
void	reset ()
	Completely reset navigation state to initial conditions.
void	resetAfterLayerSwitch ()
	Reset navigation state after switching layers.
void	resetAfterVolumeSwitch ()
	Reset navigation state after switching volumes.

Public Attributes
const Layer *	currentLayer = nullptr
	Current layer during navigation.
const Surface *	currentSurface = nullptr
	Current surface during navigation.
const TrackingVolume *	currentVolume = nullptr
	Current volume during navigation.
std::vector< std::pair< const Surface *, bool > >	freeCandidates {}
	Free candidates not part of the tracking geometry.
NavigationBoundaries	navBoundaries = {}
	the vector of boundary surfaces to work through
std::optional< std::size_t >	navBoundaryIndex
	the current boundary index of the navigation state
std::optional< std::size_t >	navCandidateIndex
	the current candidate index of the navigation state
NavigationCandidates	navCandidates = {}
	the vector of navigation candidates to work through
bool	navigationBreak = false
	Flag to break navigation loop.
Stage	navigationStage = Stage::initial
	Current navigation stage in the state machine.
std::optional< std::size_t >	navLayerIndex
	the current layer index of the navigation state
NavigationLayers	navLayers = {}
	the vector of navigation layers to work through
std::optional< std::size_t >	navSurfaceIndex
	the current surface index of the navigation state
NavigationSurfaces	navSurfaces = {}
	the vector of navigation surfaces to work through
Options	options
	Navigation options configuration.
const Layer *	startLayer = nullptr
	Layer where the navigation started.
const Surface *	startSurface = nullptr
	Surface where the navigation started.
const TrackingVolume *	startVolume = nullptr
NavigatorStatistics	statistics
	Statistics collection for navigation performance.
NavigationStream	stream
	Stream for navigation debugging and monitoring.
const Surface *	targetSurface = nullptr
	Target surface for navigation.

Detailed Description

Nested State struct.

It acts as an internal state which is created for every propagation and meant to keep thread-local navigation information.

Constructor & Destructor Documentation

State()

Acts::Navigator::State::State ( const Options & options_ )

explicit

Constructor with navigation options.

Parameters

options_

The navigation options for this state

Member Function Documentation

navBoundary()

NavigationTarget & Acts::Navigator::State::navBoundary

(

)

Get reference to current navigation boundary.

Returns

Reference to current boundary intersection

navCandidate()

NavigationTarget & Acts::Navigator::State::navCandidate

(

)

Get reference to current navigation candidate.

Returns

Reference to current boundary intersection

navLayer()

NavigationTarget & Acts::Navigator::State::navLayer

(

)

Get reference to current navigation layer.

Returns

Reference to current layer intersection

navSurface()

NavigationTarget & Acts::Navigator::State::navSurface

(

)

reset()

void Acts::Navigator::State::reset

(

)

Completely reset navigation state to initial conditions.

resetAfterLayerSwitch()

void Acts::Navigator::State::resetAfterLayerSwitch

(

)

Reset navigation state after switching layers.

resetAfterVolumeSwitch()

void Acts::Navigator::State::resetAfterVolumeSwitch

(

)

Reset navigation state after switching volumes.

Member Data Documentation

currentLayer

const Layer* Acts::Navigator::State::currentLayer = nullptr

Current layer during navigation.

currentSurface

const Surface* Acts::Navigator::State::currentSurface = nullptr

Current surface during navigation.

currentVolume

const TrackingVolume* Acts::Navigator::State::currentVolume = nullptr

Current volume during navigation.

freeCandidates

std::vector<std::pair<const Surface*, bool> > Acts::Navigator::State::freeCandidates {}

Free candidates not part of the tracking geometry.

and a boolean indicating whether the surface has already been reached during propagation

navBoundaries

NavigationBoundaries Acts::Navigator::State::navBoundaries = {}

the vector of boundary surfaces to work through

navBoundaryIndex

std::optional<std::size_t> Acts::Navigator::State::navBoundaryIndex

the current boundary index of the navigation state

navCandidateIndex

std::optional<std::size_t> Acts::Navigator::State::navCandidateIndex

the current candidate index of the navigation state

navCandidates

NavigationCandidates Acts::Navigator::State::navCandidates = {}

the vector of navigation candidates to work through

navigationBreak

bool Acts::Navigator::State::navigationBreak = false

Flag to break navigation loop.

navigationStage

Stage Acts::Navigator::State::navigationStage = Stage::initial

Current navigation stage in the state machine.

navLayerIndex

std::optional<std::size_t> Acts::Navigator::State::navLayerIndex

the current layer index of the navigation state

navLayers

NavigationLayers Acts::Navigator::State::navLayers = {}

the vector of navigation layers to work through

navSurfaceIndex

std::optional<std::size_t> Acts::Navigator::State::navSurfaceIndex

the current surface index of the navigation state

navSurfaces

NavigationSurfaces Acts::Navigator::State::navSurfaces = {}

the vector of navigation surfaces to work through

options

Options Acts::Navigator::State::options

Navigation options configuration.

startLayer

const Layer* Acts::Navigator::State::startLayer = nullptr

Layer where the navigation started.

startSurface

const Surface* Acts::Navigator::State::startSurface = nullptr

Surface where the navigation started.

startVolume

const TrackingVolume* Acts::Navigator::State::startVolume = nullptr

statistics

NavigatorStatistics Acts::Navigator::State::statistics

Statistics collection for navigation performance.

stream

NavigationStream Acts::Navigator::State::stream

Stream for navigation debugging and monitoring.

targetSurface

const Surface* Acts::Navigator::State::targetSurface = nullptr

Target surface for navigation.