Acts::TrivialPortalLink Class Reference

Trivial portal link links to a single target volume on every point on a surface. More...

#include <Acts/Geometry/TrivialPortalLink.hpp>

Inheritance diagram for Acts::TrivialPortalLink:

Collaboration diagram for Acts::TrivialPortalLink:

Public Member Functions
	TrivialPortalLink (std::shared_ptr< RegularSurface > surface, TrackingVolume &volume)
	Construct a trivial portal link from a surface and a volume.
std::unique_ptr< GridPortalLink >	makeGrid (AxisDirection direction) const
	Make a 1D grid portal link from this trivial portal link The grid size is automatically determined from the surface bounds.
Result< const TrackingVolume * >	resolveVolume (const GeometryContext &gctx, const Vector2 &position, double tolerance=s_onSurfaceTolerance) const override
	Resolve the volume for a 2D position.
Result< const TrackingVolume * >	resolveVolume (const GeometryContext &gctx, const Vector3 &position, double tolerance=s_onSurfaceTolerance) const override
	Resolve the volume for a 3D position.
void	toStream (std::ostream &os) const override
	Print the portal link to a stream.
const TrackingVolume &	volume () const
	Get the single volume that this trivial portal link is associated with.
Public Member Functions inherited from Acts::PortalLinkBase
virtual	~PortalLinkBase ()=default
	Virtual destructor in case the object is held as a derived.
void	setSurface (std::shared_ptr< RegularSurface > surface)
	Setter for the surface.
const RegularSurface &	surface () const
	Getter for the associated surface.
const std::shared_ptr< RegularSurface > &	surfacePtr () const
	Getter for the underlying shared pointer.

Additional Inherited Members
Static Public Member Functions inherited from Acts::PortalLinkBase
static std::unique_ptr< PortalLinkBase >	merge (std::unique_ptr< PortalLinkBase > a, std::unique_ptr< PortalLinkBase > b, AxisDirection direction, const Logger &logger=getDummyLogger())
	Merge two portal link into a single one.
Protected Member Functions inherited from Acts::PortalLinkBase
	PortalLinkBase (std::shared_ptr< RegularSurface > surface)
	Constructor from a surface.
Static Protected Member Functions inherited from Acts::PortalLinkBase
static void	checkMergePreconditions (const PortalLinkBase &a, const PortalLinkBase &b, AxisDirection direction)
	Helper function to check a number of preconditions before merging is executed.
Protected Attributes inherited from Acts::PortalLinkBase
std::shared_ptr< RegularSurface >	m_surface
	Surface associated with this portal link.

Detailed Description

Trivial portal link links to a single target volume on every point on a surface.

Constructor & Destructor Documentation

TrivialPortalLink()

Acts::TrivialPortalLink::TrivialPortalLink	(	std::shared_ptr< RegularSurface >	surface,
		TrackingVolume &	volume )

Construct a trivial portal link from a surface and a volume.

Parameters

surface	is the surface
volume	is the target

Member Function Documentation

makeGrid()

std::unique_ptr< GridPortalLink > Acts::TrivialPortalLink::makeGrid

(

AxisDirection

direction

)

const

Make a 1D grid portal link from this trivial portal link The grid size is automatically determined from the surface bounds.

Parameters

direction

The axis direction of the grid

Returns

A grid

resolveVolume() [1/2]

Result< const TrackingVolume * > Acts::TrivialPortalLink::resolveVolume ( const GeometryContext & gctx, const Vector2 & position, double tolerance = s_onSurfaceTolerance ) const

overridevirtual

Resolve the volume for a 2D position.

Note

Always returns the single target volume

Parameters

gctx	is the geometry context
position	is the 2D position
tolerance	is the tolerance

Returns

The target volume (can be null)

Implements Acts::PortalLinkBase.

resolveVolume() [2/2]

Result< const TrackingVolume * > Acts::TrivialPortalLink::resolveVolume ( const GeometryContext & gctx, const Vector3 & position, double tolerance = s_onSurfaceTolerance ) const

overridevirtual

Resolve the volume for a 3D position.

Note

Always returns the single target volume

Parameters

gctx	is the geometry context
position	is the 2D position
tolerance	is the tolerance

Returns

The target volume (can be null)

Note

The position is assumed to be on the associated surface.

Implements Acts::PortalLinkBase.

toStream()

void Acts::TrivialPortalLink::toStream ( std::ostream & os ) const

overridevirtual

Print the portal link to a stream.

Parameters

os	output stream

Implements Acts::PortalLinkBase.

volume()

const TrackingVolume & Acts::TrivialPortalLink::volume

(

)

const

Get the single volume that this trivial portal link is associated with.

Returns

The target volume