Acts::SingleCylinderPortalShell Class Reference

This class describes a cylinder shell containing a single volume. More...

#include <Acts/Geometry/CylinderPortalShell.hpp>

Inheritance diagram for Acts::SingleCylinderPortalShell:

Collaboration diagram for Acts::SingleCylinderPortalShell:

Public Types
using	Base = CylinderPortalShell
	Type alias for base cylinder portal shell class.
Public Types inherited from Acts::CylinderPortalShell
using	Face = CylinderVolumeBounds::Face
	Type alias for cylinder volume bounds face enumeration.

Public Member Functions
	SingleCylinderPortalShell (TrackingVolume &volume)
	Construct a single cylinder portal shell for the given volume.
void	applyToVolume () override
	Instruct the shell to register the portals with the volume, handing over shared ownership in the process.
bool	isValid () const override
	Check if a portal is valid, e.g.
std::string	label () const override
	Get a label for the portal shell for debugging purposes.
std::shared_ptr< Portal >	portal (Face face) final
	Retrieve a shared_ptr for the portal associated to the given face.
void	setPortal (std::shared_ptr< Portal > portal, Face face) final
	Set the portal associated to the given face.
std::size_t	size () const final
	Get the number of portals in the shell.
Public Member Functions inherited from Acts::CylinderPortalShell
void	fill (TrackingVolume &volume) override
	Fill the open slots of the shell with a TrivialPortalLink to the given volume.
Public Member Functions inherited from Acts::PortalShellBase
virtual	~PortalShellBase ()=default
	Virtual destructor.

Detailed Description

This class describes a cylinder shell containing a single volume.

The available faces depend on the configuration of the cylinder volume bounds. If a phi sector is configured, the shell will have corresponding portal slots. If the inner radius is non-zero, the shell will have an inner cylinder portal slot.

Member Typedef Documentation

Base

using Acts::SingleCylinderPortalShell::Base = CylinderPortalShell

Type alias for base cylinder portal shell class.

Constructor & Destructor Documentation

SingleCylinderPortalShell()

Acts::SingleCylinderPortalShell::SingleCylinderPortalShell ( TrackingVolume & volume )

explicit

Construct a single cylinder portal shell for the given volume.

Parameters

volume

The volume to create the shell for

Member Function Documentation

applyToVolume()

void Acts::SingleCylinderPortalShell::applyToVolume ( )

overridevirtual

Instruct the shell to register the portals with the volume, handing over shared ownership in the process.

Note

The target volume depends on the shell type, e.g. composite shells like the CylinerStackPortalShell register portals to the correct volumes.

Implements Acts::PortalShellBase.

isValid()

bool Acts::SingleCylinderPortalShell::isValid ( ) const

overridevirtual

Check if a portal is valid, e.g.

if non of the portals has two unconnected sides.

Returns

True if the shell is valid, false otherwise

Implements Acts::PortalShellBase.

label()

std::string Acts::SingleCylinderPortalShell::label ( ) const

overridevirtual

Get a label for the portal shell for debugging purposes.

Returns

A label for the portal shell

Implements Acts::PortalShellBase.

portal()

std::shared_ptr< Portal > Acts::SingleCylinderPortalShell::portal ( Face face )

finalvirtual

Retrieve a shared_ptr for the portal associated to the given face.

Can be nullptr if unset.

Parameters

face	The face to retrieve the portal for

Returns

The portal associated to the face

Implements Acts::CylinderPortalShell.

setPortal()

void Acts::SingleCylinderPortalShell::setPortal ( std::shared_ptr< Portal > portal, Face face )

finalvirtual

Set the portal associated to the given face.

Parameters

portal	The portal to set
face	The face to set the portal

Implements Acts::CylinderPortalShell.

size()

std::size_t Acts::SingleCylinderPortalShell::size ( ) const

finalvirtual

Get the number of portals in the shell.

This number depends on the volume type

Returns

The number of portals in the shell

Implements Acts::PortalShellBase.