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

#include <acts/blob/sPHENIX/Tests/UnitTests/Core/Geometry/LayerStub.hpp>

+ Inheritance diagram for Acts::LayerStub:
+ Collaboration diagram for Acts::LayerStub:

Public Member Functions

 LayerStub ()=delete
 constructor (deleted in Surface baseclass)
 
 LayerStub (const LayerStub &otherLayer)=delete
 copy constructor (deleted in Surface baseclass)
 
 LayerStub (std::unique_ptr< SurfaceArray > surfaceArray, double thickness=0, std::unique_ptr< ApproachDescriptor > ad=nullptr, LayerType ltype=passive)
 constructor with pointer to SurfaceArray (protected in Layer baseclass)
 
 ~LayerStub () override=default
 Destructor.
 
LayerStuboperator= (const LayerStub &lay)=delete
 Assignment is deleted in the Layer baseclass.
 
const SurfacesurfaceRepresentation () const override
 surfaceRepresentation is pure virtual in baseclass
 
SurfacesurfaceRepresentation () override
 
bool constructedOk () const
 
- Public Member Functions inherited from Acts::SurfaceStub
 SurfaceStub (const Transform3 &htrans=Transform3::Identity())
 
 SurfaceStub (const GeometryContext &gctx, const SurfaceStub &sf, const Transform3 &transf)
 
 SurfaceStub (const DetectorElementBase &detelement)
 
 ~SurfaceStub () override=default
 
SurfaceType type () const final
 Return method for the Surface type to avoid dynamic casts.
 
Vector3 normal (const GeometryContext &gctx, const Vector2 &) const final
 Return method for the normal vector of the surface.
 
Vector3 normal (const GeometryContext &gctx, const Vector3 &) const final
 
Vector3 normal (const GeometryContext &) const final
 
const SurfaceBoundsbounds () const final
 Return method for SurfaceBounds.
 
Vector3 localToGlobal (const GeometryContext &, const Vector2 &, const Vector3 &) const final
 Local to global transformation.
 
Result< Vector2globalToLocal (const GeometryContext &, const Vector3 &, const Vector3 &, double) const final
 Global to local transformation.
 
double pathCorrection (const GeometryContext &, const Vector3 &, const Vector3 &) const final
 Calculation of the path correction for incident.
 
Vector3 binningPosition (const GeometryContext &, BinningValue) const final
 Inherited from GeometryObject base.
 
SurfaceMultiIntersection intersect (const GeometryContext &, const Vector3 &, const Vector3 &, const BoundaryCheck &, const ActsScalar) const final
 Surface intersction.
 
std::string name () const final
 Return properly formatted class name.
 
bool constructedOk () const
 Simply return true to check a method can be called on a constructed object.
 
Polyhedron polyhedronRepresentation (const GeometryContext &, size_t) const final
 Return a Polyhedron for the surfaces.
 
ActsMatrix< 2, 3 > localCartesianToBoundLocalDerivative (const GeometryContext &, const Vector3 &) const final
 
- Public Member Functions inherited from Acts::Surface
virtual ~Surface ()
 
std::shared_ptr< SurfacegetSharedPtr ()
 
std::shared_ptr< const SurfacegetSharedPtr () const
 
Surfaceoperator= (const Surface &other)
 
virtual bool operator== (const Surface &other) const
 
virtual bool operator!= (const Surface &sf) const
 
virtual const Transform3transform (const GeometryContext &gctx) const
 
virtual Vector3 center (const GeometryContext &gctx) const
 
const DetectorElementBaseassociatedDetectorElement () const
 
const LayerassociatedLayer () const
 
void associateLayer (const Layer &lay)
 
const ISurfaceMaterialsurfaceMaterial () const
 
const std::shared_ptr< const
ISurfaceMaterial > & 
surfaceMaterialSharedPtr () const
 
void assignDetectorElement (const DetectorElementBase &detelement)
 
void assignSurfaceMaterial (std::shared_ptr< const ISurfaceMaterial > material)
 
bool isOnSurface (const GeometryContext &gctx, const Vector3 &position, const Vector3 &direction, const BoundaryCheck &bcheck=true) const
 
virtual bool insideBounds (const Vector2 &lposition, const BoundaryCheck &bcheck=true) const
 
virtual Acts::RotationMatrix3 referenceFrame (const GeometryContext &gctx, const Vector3 &position, const Vector3 &direction) const
 
virtual BoundToFreeMatrix boundToFreeJacobian (const GeometryContext &gctx, const BoundVector &boundParams) const
 
virtual FreeToBoundMatrix freeToBoundJacobian (const GeometryContext &gctx, const FreeVector &parameters) const
 
virtual FreeToPathMatrix freeToPathDerivative (const GeometryContext &gctx, const FreeVector &parameters) const
 
virtual std::ostream & toStream (const GeometryContext &gctx, std::ostream &sl) const
 
std::string toString (const GeometryContext &gctx) const
 
AlignmentToBoundMatrix alignmentToBoundDerivative (const GeometryContext &gctx, const FreeVector &parameters, const FreeVector &pathDerivative) const
 
virtual AlignmentToPathMatrix alignmentToPathDerivative (const GeometryContext &gctx, const FreeVector &parameters) const
 
- Public Member Functions inherited from Acts::GeometryObject
 GeometryObject ()=default
 Defaulted constructor.
 
 GeometryObject (const GeometryObject &)=default
 Defaulted copy constructor.
 
 GeometryObject (const GeometryIdentifier &geometryId)
 
GeometryObjectoperator= (const GeometryObject &geometryId)
 
const GeometryIdentifiergeometryId () const
 
virtual double binningPositionValue (const GeometryContext &gctx, BinningValue bValue) const
 
void assignGeometryId (const GeometryIdentifier &geometryId)
 
- Public Member Functions inherited from Acts::Layer
 Layer ()=delete
 Default Constructor - deleted.
 
 Layer (const Layer &)=delete
 Copy Constructor - deleted.
 
virtual ~Layer ()=default
 Destructor.
 
Layeroperator= (const Layer &layer)=delete
 
const SurfaceArraysurfaceArray () const
 Return the entire SurfaceArray, returns a nullptr if no SurfaceArray.
 
SurfaceArraysurfaceArray ()
 Non-const version.
 
double thickness () const
 
virtual bool isOnLayer (const GeometryContext &gctx, const Vector3 &position, const BoundaryCheck &bcheck=true) const
 
const ApproachDescriptorapproachDescriptor () const
 Return method for the approach descriptor, can be nullptr.
 
ApproachDescriptorapproachDescriptor ()
 Non-const version of the approach descriptor.
 
template<typename options_t >
bool resolve (const options_t &options) const
 
virtual bool resolve (bool resolveSensitive, bool resolveMaterial, bool resolvePassive) const
 
boost::container::small_vector
< SurfaceIntersection, 10 > 
compatibleSurfaces (const GeometryContext &gctx, const Vector3 &position, const Vector3 &direction, const NavigationOptions< Surface > &options) const
 Decompose Layer into (compatible) surfaces.
 
SurfaceIntersection surfaceOnApproach (const GeometryContext &gctx, const Vector3 &position, const Vector3 &direction, const NavigationOptions< Layer > &options) const
 
const LayernextLayer (const GeometryContext &gctx, const Vector3 &position, const Vector3 &direction) const
 
const TrackingVolumetrackingVolume () const
 
const AbstractVolumerepresentingVolume () const
 
LayerType layerType () const
 return the LayerType
 

Additional Inherited Members

- Public Types inherited from Acts::Surface
enum  SurfaceType {
  Cone = 0, Cylinder = 1, Disc = 2, Perigee = 3,
  Plane = 4, Straw = 5, Curvilinear = 6, Other = 7
}
 
- Static Public Member Functions inherited from Acts::Surface
template<class T , typename... Args>
static std::shared_ptr< TmakeShared (Args &&...args)
 
- Static Public Attributes inherited from Acts::Surface
static std::array< std::string,
SurfaceType::Other > 
s_surfaceTypeNames
 Helper strings for screen output.
 
- Protected Member Functions inherited from Acts::Surface
 Surface (const Transform3 &transform=Transform3::Identity())
 
 Surface (const Surface &other)
 
 Surface (const DetectorElementBase &detelement)
 
 Surface (const GeometryContext &gctx, const Surface &other, const Transform3 &shift)
 
- Protected Member Functions inherited from Acts::Layer
 Layer (std::unique_ptr< SurfaceArray > surfaceArray, double thickness=0., std::unique_ptr< ApproachDescriptor > ades=nullptr, LayerType laytyp=passive)
 
void encloseTrackingVolume (const TrackingVolume &tvol)
 
- Protected Attributes inherited from Acts::Surface
Transform3 m_transform = Transform3::Identity()
 
const DetectorElementBasem_associatedDetElement {nullptr}
 Pointer to the a DetectorElementBase.
 
const Layerm_associatedLayer {nullptr}
 
const TrackingVolumem_associatedTrackingVolume {nullptr}
 
std::shared_ptr< const
ISurfaceMaterial
m_surfaceMaterial
 Possibility to attach a material description.
 
- Protected Attributes inherited from Acts::Layer
NextLayers m_nextLayers
 the previous Layer according to BinGenUtils
 
const BinUtilitym_nextLayerUtility = nullptr
 
std::unique_ptr< const
SurfaceArray
m_surfaceArray = nullptr
 
double m_layerThickness = 0.
 Thickness of the Layer.
 
std::unique_ptr< const
ApproachDescriptor
m_approachDescriptor = nullptr
 
const TrackingVolumem_trackingVolume = nullptr
 the enclosing TrackingVolume
 
std::unique_ptr< AbstractVolumem_representingVolume = nullptr
 
LayerType m_layerType
 make a passive/active either way
 
int m_ssRepresentingSurface = 0
 sub structure indication
 
int m_ssSensitiveSurfaces = 0
 
int m_ssApproachSurfaces = 0
 

Detailed Description

Layer derived class stub Note: Layer classes in general have a static 'create' factory method, but nothing in the baseclasses mandates this.

Definition at line 20 of file LayerStub.hpp.

View newest version in sPHENIX GitHub at line 20 of file LayerStub.hpp

Constructor & Destructor Documentation

Acts::LayerStub::LayerStub ( )
delete

constructor (deleted in Surface baseclass)

Acts::LayerStub::LayerStub ( const LayerStub otherLayer)
delete

copy constructor (deleted in Surface baseclass)

Acts::LayerStub::LayerStub ( std::unique_ptr< SurfaceArray surfaceArray,
double  thickness = 0,
std::unique_ptr< ApproachDescriptor ad = nullptr,
LayerType  ltype = passive 
)
inline

constructor with pointer to SurfaceArray (protected in Layer baseclass)

Definition at line 27 of file LayerStub.hpp.

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

Acts::LayerStub::~LayerStub ( )
overridedefault

Destructor.

Member Function Documentation

bool Acts::LayerStub::constructedOk ( ) const
inline

simply return true to show a method can be called on the constructed object

Definition at line 46 of file LayerStub.hpp.

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

Referenced by Acts::Test::Layers::BOOST_AUTO_TEST_CASE().

+ Here is the caller graph for this function:

LayerStub& Acts::LayerStub::operator= ( const LayerStub lay)
delete

Assignment is deleted in the Layer baseclass.

const Surface& Acts::LayerStub::surfaceRepresentation ( ) const
inlineoverridevirtual

surfaceRepresentation is pure virtual in baseclass

Implements Acts::Layer.

Definition at line 40 of file LayerStub.hpp.

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

Surface& Acts::LayerStub::surfaceRepresentation ( )
inlineoverridevirtual

Implements Acts::Layer.

Definition at line 42 of file LayerStub.hpp.

View newest version in sPHENIX GitHub at line 42 of file LayerStub.hpp


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