ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::NavigationOptions< object_t > Struct Template Reference

struct for the Navigation options that are forwarded to the geometry More...

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

+ Collaboration diagram for Acts::NavigationOptions< object_t >:

Public Member Functions

 NavigationOptions (NavigationDirection ndir, BoundaryCheck bcheck, bool resolves=true, bool resolvem=true, bool resolvep=false, const object_t *sobject=nullptr, const object_t *eobject=nullptr)
 

Public Attributes

NavigationDirection navDir = forward
 The navigation direction.
 
BoundaryCheck boundaryCheck = true
 The boundary check directive.
 
bool resolveSensitive = true
 Always look for sensitive.
 
bool resolveMaterial = true
 Always look for material.
 
bool resolvePassive = false
 always look for passive
 
const object_t * startObject = nullptr
 object to check against: at start
 
const object_t * endObject = nullptr
 object to check against: at end
 
const SurfacetargetSurface = nullptr
 Target surface to exclude.
 
double pathLimit = std::numeric_limits<double>::max()
 The maximum path limit for this navigation step.
 
double overstepLimit = -1_um
 

Detailed Description

template<typename object_t>
struct Acts::NavigationOptions< object_t >

struct for the Navigation options that are forwarded to the geometry

Template Parameters
propagator_state_tType of the object for navigation state
object_tType of the object for navigation to check against

Definition at line 35 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 35 of file Navigator.hpp

Constructor & Destructor Documentation

template<typename object_t>
Acts::NavigationOptions< object_t >::NavigationOptions ( NavigationDirection  ndir,
BoundaryCheck  bcheck,
bool  resolves = true,
bool  resolvem = true,
bool  resolvep = false,
const object_t *  sobject = nullptr,
const object_t *  eobject = nullptr 
)
inline

Constructor

Parameters
nDirNavigation direction prescription
bcheckBoundary check for the navigation action
sobjectStart object to check against
eobjectEnd object to check against
maxStepLengthMaximal step length to check against

Definition at line 73 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 73 of file Navigator.hpp

Member Data Documentation

template<typename object_t>
BoundaryCheck Acts::NavigationOptions< object_t >::boundaryCheck = true

The boundary check directive.

Definition at line 40 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 40 of file Navigator.hpp

template<typename object_t>
const object_t* Acts::NavigationOptions< object_t >::endObject = nullptr

object to check against: at end

Definition at line 53 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 53 of file Navigator.hpp

template<typename object_t>
NavigationDirection Acts::NavigationOptions< object_t >::navDir = forward

The navigation direction.

Definition at line 37 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 37 of file Navigator.hpp

template<typename object_t>
double Acts::NavigationOptions< object_t >::overstepLimit = -1_um

The overstep tolerance for this navigation step

Note
must be negative as it describes overstepping

Definition at line 64 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 64 of file Navigator.hpp

Referenced by Acts::Navigator::resolveSurfaces(), Acts::Navigator::targetBoundaries(), and Acts::Navigator::targetLayers().

template<typename object_t>
double Acts::NavigationOptions< object_t >::pathLimit = std::numeric_limits<double>::max()

The maximum path limit for this navigation step.

Definition at line 59 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 59 of file Navigator.hpp

Referenced by Acts::Navigator::resolveSurfaces(), and Acts::Navigator::targetBoundaries().

template<typename object_t>
bool Acts::NavigationOptions< object_t >::resolveMaterial = true

Always look for material.

Definition at line 46 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 46 of file Navigator.hpp

template<typename object_t>
bool Acts::NavigationOptions< object_t >::resolvePassive = false

always look for passive

Definition at line 48 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 48 of file Navigator.hpp

template<typename object_t>
bool Acts::NavigationOptions< object_t >::resolveSensitive = true

Always look for sensitive.

Definition at line 44 of file Navigator.hpp.

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

template<typename object_t>
const object_t* Acts::NavigationOptions< object_t >::startObject = nullptr

object to check against: at start

Definition at line 51 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 51 of file Navigator.hpp

Referenced by Acts::Navigator::targetBoundaries().

template<typename object_t>
const Surface* Acts::NavigationOptions< object_t >::targetSurface = nullptr

Target surface to exclude.

Definition at line 56 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 56 of file Navigator.hpp

Referenced by Acts::Navigator::resolveLayers().


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