Trk::BoundarySurface< Tvol > Class Template Reference

Description of a BoundarySurface inside the tracking realm, it extends the Surface description to make a surface being a boundary of a Trk::Volume, Trk::TrackingVolume or a Trk::MagneticFieldVolume. More...

#include <BoundarySurface.h>

Inheritance diagram for Trk::BoundarySurface< Tvol >:

Collaboration diagram for Trk::BoundarySurface< Tvol >:

Public Member Functions
	BoundarySurface ()=default
	Default Constructor - needed for pool and inherited classes.
	BoundarySurface (const Tvol *inside, const Tvol *outside)
	Constructor for a Boundary with exact two Volumes attached to it.
	BoundarySurface (std::shared_ptr< const VolumeArray > insideArray, std::shared_ptr< const VolumeArray > outsideArray)
	Constructor for a Boundary with exact two Volumes attached to it.
virtual const Tvol *	attachedVolume (const TrackParameters &parms, PropDirection dir) const =0
	Get the next Volume depending on the TrackParameters and the requested direction.
virtual const Tvol *	attachedVolume (const Amg::Vector3D &pos, const Amg::Vector3D &mom, PropDirection dir) const =0
	Get the next Volume depending on GlobalPosition, GlobalMomentum, dir on the TrackParameters and the requested direction.
template<class T>
bool	onBoundary (const T &pars) const
	templated onBoundary method
virtual const Surface &	surfaceRepresentation () const =0
	The Surface Representation of this.
virtual Surface &	surfaceRepresentation ()=0
virtual	~BoundarySurface ()
	Virtual Destructor.
void	debugInfo (MsgStream &msg) const
	output debug information
Tvol const *	insideVolume () const
	getters/setters for inside/outside Volume
void	setInsideVolume (const Tvol *vol)
Tvol const *	outsideVolume () const
void	setOutsideVolume (const Tvol *vol)
const VolumeArray *	insideVolumeArray () const
	getters/setters for inside/outside Volume arrays
void	setInsideVolumeArray (std::shared_ptr< const VolumeArray > volArray)
const VolumeArray *	outsideVolumeArray () const
void	setOutsideVolumeArray (std::shared_ptr< const VolumeArray > volArray)

Protected Attributes
const Tvol *	m_insideVolume {}
const Tvol *	m_outsideVolume {}
std::shared_ptr< const VolumeArray >	m_insideVolumeArray {}
std::shared_ptr< const VolumeArray >	m_outsideVolumeArray {}

Private Types
typedef BinnedArray< Tvol >	VolumeArray
	typedef the BinnedArray

Detailed Description

template<class Tvol>
class Trk::BoundarySurface< Tvol >

Description of a BoundarySurface inside the tracking realm, it extends the Surface description to make a surface being a boundary of a Trk::Volume, Trk::TrackingVolume or a Trk::MagneticFieldVolume.

A Trk::BoundarySurface can have an inside Volume and an outside Volume, resp. a Trk::BinnedArray for inside or outside direction.

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 43 of file BoundarySurface.h.

Member Typedef Documentation

VolumeArray

template<class Tvol>

typedef BinnedArray<Tvol> Trk::BoundarySurface< Tvol >::VolumeArray

private

typedef the BinnedArray

Definition at line 45 of file BoundarySurface.h.

Constructor & Destructor Documentation

BoundarySurface() [1/3]

template<class Tvol>

Trk::BoundarySurface< Tvol >::BoundarySurface ( )

default

Default Constructor - needed for pool and inherited classes.

BoundarySurface() [2/3]

template<class Tvol>

Trk::BoundarySurface< Tvol >::BoundarySurface ( const Tvol * inside, const Tvol * outside )

inline

Constructor for a Boundary with exact two Volumes attached to it.

Definition at line 51 of file BoundarySurface.h.

      : m_insideVolume(inside),
        m_outsideVolume(outside),
        m_insideVolumeArray(),
        m_outsideVolumeArray() {}

BoundarySurface() [3/3]

template<class Tvol>

Trk::BoundarySurface< Tvol >::BoundarySurface ( std::shared_ptr< const VolumeArray > insideArray, std::shared_ptr< const VolumeArray > outsideArray )

inline

Constructor for a Boundary with exact two Volumes attached to it.

Definition at line 58 of file BoundarySurface.h.

      : m_insideVolume(),
        m_outsideVolume(),
        m_insideVolumeArray(std::move(insideArray)),
        m_outsideVolumeArray(std::move(outsideArray)) {}

~BoundarySurface()

template<class Tvol>

virtual Trk::BoundarySurface< Tvol >::~BoundarySurface ( )

inlinevirtual

Virtual Destructor.

Definition at line 88 of file BoundarySurface.h.

{}

Member Function Documentation

attachedVolume() [1/2]

template<class Tvol>

virtual const Tvol * Trk::BoundarySurface< Tvol >::attachedVolume ( const Amg::Vector3D & pos, const Amg::Vector3D & mom, PropDirection dir ) const

pure virtual

Get the next Volume depending on GlobalPosition, GlobalMomentum, dir on the TrackParameters and the requested direction.

Implemented in Trk::BoundaryCylinderSurface< Tvol >, Trk::BoundaryDiscSurface< Tvol >, Trk::BoundaryPlaneSurface< Tvol >, Trk::BoundarySubtractedCylinderSurface< Tvol >, and Trk::BoundarySubtractedPlaneSurface< Tvol >.

attachedVolume() [2/2]

template<class Tvol>

virtual const Tvol * Trk::BoundarySurface< Tvol >::attachedVolume ( const TrackParameters & parms, PropDirection dir ) const

pure virtual

Get the next Volume depending on the TrackParameters and the requested direction.

Implemented in Trk::BoundaryCylinderSurface< Tvol >, Trk::BoundaryDiscSurface< Tvol >, Trk::BoundaryPlaneSurface< Tvol >, Trk::BoundarySubtractedCylinderSurface< Tvol >, and Trk::BoundarySubtractedPlaneSurface< Tvol >.

debugInfo()

template<class Tvol>

void Trk::BoundarySurface< Tvol >::debugInfo ( MsgStream & msg ) const

inline

output debug information

Definition at line 133 of file BoundarySurface.h.

                                                                 {
  msg << "BoundarySurface debug information: " << std::endl;
  msg << "     -> pointer to insideVolume         = " << m_insideVolume
      << std::endl;
  msg << "     -> pointer to insideVolumeArray    = "
      << m_insideVolumeArray.get() << std::endl;
  msg << "     -> pointer to outsideVolume        = " << m_outsideVolume
      << std::endl;
  msg << "     -> pointer to outsideVolumeArray   = "
      << m_outsideVolumeArray.get() << endmsg;
}

insideVolume()

template<class Tvol>

Tvol const * Trk::BoundarySurface< Tvol >::insideVolume ( ) const

inline

getters/setters for inside/outside Volume

Definition at line 94 of file BoundarySurface.h.

                                  {
    return m_insideVolume;
  }

insideVolumeArray()

template<class Tvol>

const VolumeArray * Trk::BoundarySurface< Tvol >::insideVolumeArray ( ) const

inline

getters/setters for inside/outside Volume arrays

Definition at line 109 of file BoundarySurface.h.

                                              {
    return m_insideVolumeArray.get();
  }

onBoundary()

template<class Tvol>

template<class T>

bool Trk::BoundarySurface< Tvol >::onBoundary ( const T & pars ) const

inline

templated onBoundary method

Definition at line 79 of file BoundarySurface.h.

                                       {
    return surfaceRepresentation().onSurface(pars);
  }

outsideVolume()

template<class Tvol>

Tvol const * Trk::BoundarySurface< Tvol >::outsideVolume ( ) const

inline

Definition at line 101 of file BoundarySurface.h.

                                   {
    return m_outsideVolume;
  }

outsideVolumeArray()

template<class Tvol>

const VolumeArray * Trk::BoundarySurface< Tvol >::outsideVolumeArray ( ) const

inline

Definition at line 115 of file BoundarySurface.h.

                                               {
   return m_outsideVolumeArray.get();
  }

setInsideVolume()

template<class Tvol>

void Trk::BoundarySurface< Tvol >::setInsideVolume ( const Tvol * vol )

inline

Definition at line 97 of file BoundarySurface.h.

                                       {
    m_insideVolume = vol;
  }

setInsideVolumeArray()

template<class Tvol>

void Trk::BoundarySurface< Tvol >::setInsideVolumeArray ( std::shared_ptr< const VolumeArray > volArray )

inline

Definition at line 112 of file BoundarySurface.h.

                                                                      {
    m_insideVolumeArray = std::move(volArray);
  }

setOutsideVolume()

template<class Tvol>

void Trk::BoundarySurface< Tvol >::setOutsideVolume ( const Tvol * vol )

inline

Definition at line 104 of file BoundarySurface.h.

                                        {
    m_outsideVolume = vol;
  }

setOutsideVolumeArray()

template<class Tvol>

void Trk::BoundarySurface< Tvol >::setOutsideVolumeArray ( std::shared_ptr< const VolumeArray > volArray )

inline

Definition at line 118 of file BoundarySurface.h.

                                                                       {
    m_outsideVolumeArray = std::move(volArray);
  }

surfaceRepresentation() [1/2]

template<class Tvol>

virtual const Surface & Trk::BoundarySurface< Tvol >::surfaceRepresentation ( ) const

pure virtual

The Surface Representation of this.

Implemented in Trk::BoundaryCylinderSurface< Tvol >, Trk::BoundaryDiscSurface< Tvol >, Trk::BoundaryPlaneSurface< Tvol >, Trk::BoundarySubtractedCylinderSurface< Tvol >, and Trk::BoundarySubtractedPlaneSurface< Tvol >.

surfaceRepresentation() [2/2]

template<class Tvol>

virtual Surface & Trk::BoundarySurface< Tvol >::surfaceRepresentation ( )

pure virtual

Implemented in Trk::BoundaryCylinderSurface< Tvol >, Trk::BoundaryDiscSurface< Tvol >, Trk::BoundaryPlaneSurface< Tvol >, Trk::BoundarySubtractedCylinderSurface< Tvol >, and Trk::BoundarySubtractedPlaneSurface< Tvol >.

Member Data Documentation

m_insideVolume

template<class Tvol>

const Tvol* Trk::BoundarySurface< Tvol >::m_insideVolume {}

protected

Definition at line 124 of file BoundarySurface.h.

{};

m_insideVolumeArray

template<class Tvol>

std::shared_ptr<const VolumeArray> Trk::BoundarySurface< Tvol >::m_insideVolumeArray {}

protected

Definition at line 127 of file BoundarySurface.h.

{};

m_outsideVolume

template<class Tvol>

const Tvol* Trk::BoundarySurface< Tvol >::m_outsideVolume {}

protected

Definition at line 125 of file BoundarySurface.h.

{};

m_outsideVolumeArray

template<class Tvol>

std::shared_ptr<const VolumeArray> Trk::BoundarySurface< Tvol >::m_outsideVolumeArray {}

protected

Definition at line 128 of file BoundarySurface.h.

{};

---

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

• BoundarySurface.h