Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::Experimental::IGeometryIdGenerator Class Referenceabstract

This is the interface for generating geometry ids and assign them to detector volumes, portals and surfaces. More...

#include <acts/blob/sPHENIX/Core/include/Acts/Detector/interface/IGeometryIdGenerator.hpp>

+ Inheritance diagram for Acts::Experimental::IGeometryIdGenerator:

Public Types

using GeoIdCache = std::any
 

Public Member Functions

virtual ~IGeometryIdGenerator ()=default
 
virtual GeoIdCache generateCache () const =0
 Virtual interface method to generata a geometry id cache.
 
virtual void assignGeometryId (GeoIdCache &cache, DetectorVolume &dVolume) const =0
 
virtual void assignGeometryId (GeoIdCache &cache, Portal &portal) const =0
 
virtual void assignGeometryId (GeoIdCache &cache, Surface &surface) const =0
 The virtual interface definition for assigning a geometry id to a surface.
 

Detailed Description

This is the interface for generating geometry ids and assign them to detector volumes, portals and surfaces.

Definition at line 25 of file IGeometryIdGenerator.hpp.

View newest version in sPHENIX GitHub at line 25 of file IGeometryIdGenerator.hpp

Member Typedef Documentation

Definition at line 27 of file IGeometryIdGenerator.hpp.

View newest version in sPHENIX GitHub at line 27 of file IGeometryIdGenerator.hpp

Constructor & Destructor Documentation

virtual Acts::Experimental::IGeometryIdGenerator::~IGeometryIdGenerator ( )
virtualdefault

Member Function Documentation

virtual void Acts::Experimental::IGeometryIdGenerator::assignGeometryId ( GeoIdCache cache,
DetectorVolume dVolume 
) const
pure virtual

The virtual interface definition for assigning a geometry id to a detector volume

Parameters
cacheis the cache object for e.g. object counting
dVolumethe detector volume to assign the geometry id to

Implemented in VolumeGeoIdGenerator, SurfaceGeoIdGenerator, Acts::Experimental::GeometryIdGenerator, and SurfaceGeoIdGenerator.

virtual void Acts::Experimental::IGeometryIdGenerator::assignGeometryId ( GeoIdCache cache,
Portal portal 
) const
pure virtual

The virtual interface definition for assigning a geometry id to a portal

Parameters
cacheis the cache object for e.g. object counting
portalthe portal to assign the geometry id to

Implemented in VolumeGeoIdGenerator, SurfaceGeoIdGenerator, Acts::Experimental::GeometryIdGenerator, and SurfaceGeoIdGenerator.

virtual void Acts::Experimental::IGeometryIdGenerator::assignGeometryId ( GeoIdCache cache,
Surface surface 
) const
pure virtual

The virtual interface definition for assigning a geometry id to a surface.

Parameters
cacheis the cache object for e.g. object counting
surfacethe surface to assign the geometry id to

Implemented in VolumeGeoIdGenerator, SurfaceGeoIdGenerator, Acts::Experimental::GeometryIdGenerator, and SurfaceGeoIdGenerator.

virtual GeoIdCache Acts::Experimental::IGeometryIdGenerator::generateCache ( ) const
pure virtual

Virtual interface method to generata a geometry id cache.

Returns
a geometry id cache decorated in a std::any object

Implemented in VolumeGeoIdGenerator, SurfaceGeoIdGenerator, Acts::Experimental::GeometryIdGenerator, and SurfaceGeoIdGenerator.


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