DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | List of all members
dd4hep::CartesianStripY Class Reference

Implementation class for the strip Y segmentation. More...

#include <CartesianStripY.h>

Inheritance diagram for dd4hep::CartesianStripY:
dd4hep::Handle< T >

Public Member Functions

 CartesianStripY ()=default
 Default constructor. More...
 
 CartesianStripY (const CartesianStripY &e)=default
 Copy constructor. More...
 
 CartesianStripY (const Segmentation &e)
 Copy Constructor from segmentation base object. More...
 
 CartesianStripY (const Handle< Object > &e)
 Copy constructor from handle. More...
 
template<typename Q >
 CartesianStripY (const Handle< Q > &e)
 Copy constructor from other equivalent handle. More...
 
CartesianStripYoperator= (const CartesianStripY &seg)=default
 Assignment operator. More...
 
bool operator== (const CartesianStripY &seg) const
 Equality operator. More...
 
Position position (const CellID &cellID) const
 determine the position based on the cell ID More...
 
CellID cellID (const Position &local, const Position &global, const VolumeID &volID) const
 determine the cell ID based on the position More...
 
double stripSizeY () const
 access the strip size in Y More...
 
void setStripSizeY (double cellSize) const
 set the strip size in Y More...
 
double offsetY () const
 access the coordinate offset in Y More...
 
void setOffsetY (double offset) const
 set the coordinate offset in Y More...
 
const std::string & fieldNameY () const
 access the field name used for Y More...
 
std::vector< double > cellDimensions (const CellID &cellID) const
 Returns a vector<double> of the cellDimensions of the given cell ID in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi. More...
 
- Public Member Functions inherited from dd4hep::Handle< T >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< T > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< T > &element)=default
 Copy constructor. More...
 
 Handle (T *element)
 Initializing constructor from pointer. More...
 
template<typename Q >
 Handle (Q *element)
 Initializing constructor from unrelated pointer with type checking. More...
 
template<typename Q >
 Handle (const Handle< Q > &element)
 Initializing constructor from unrelated handle with type checking. More...
 
Handle< T > & operator= (Handle< T > &&element)=default
 Assignment move operator. More...
 
Handle< T > & operator= (const Handle< T > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< T > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< T > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< T > &element) const
 Boolean operator > used for RB tree insertions. More...
 
bool isValid () const
 Check the validity of the object held by the handle. More...
 
bool operator! () const
 Check the validity of the object held by the handle. More...
 
Handle< T > & clear ()
 Release the object held by the handle. More...
 
T * operator-> () const
 Access the held object using the -> operator. More...
 
 operator T& () const
 Automatic type conversion to an object references. More...
 
T & operator* () const
 Access the held object using the * operator. More...
 
T * ptr () const
 Access to the held object. More...
 
template<typename Q >
Q * _ptr () const
 Access to an unrelated object type. More...
 
template<typename Q >
Q * data () const
 Access to an unrelated object type. More...
 
template<typename Q >
Q & object () const
 Access to an unrelated object type. More...
 
T * access () const
 Checked object access. Throws invalid handle runtime exception if invalid handle. More...
 
const char * name () const
 Access the object name (or "" if not supported by the object) More...
 
void assign (Object *n, const std::string &nam, const std::string &title)
 Assign a new named object. Note: object references must be managed by the user. More...
 
void destroy ()
 Destroy the underlying object (be careful here: things are not reference counted)! More...
 
void assign (_Segmentation *s, const std::string &n, const std::string &)
 
const char * name () const
 
const char * name () const
 
void assign (NamedObject *p, const std::string &n, const std::string &t)
 

Additional Inherited Members

- Public Types inherited from dd4hep::Handle< T >
typedef T Object
 Extern accessible definition of the contained element type. More...
 
typedef Handle< T > Base
 Self type: used by sub-classes. More...
 
- Static Public Member Functions inherited from dd4hep::Handle< T >
static void bad_assignment (const std::type_info &from, const std::type_info &to)
 Helper routine called when unrelated types are assigned. More...
 
- Public Attributes inherited from dd4hep::Handle< T >
T * m_element {nullptr}
 Single and only data member: Reference to the actual element. More...
 

Detailed Description

Implementation class for the strip Y segmentation.

Concrete user handle to serve specific needs of client code which requires access to the base functionality not served by the super-class Segmentation.

Note: We only check the validity of the underlying handle. If for whatever reason the implementation object is not valid This is not checked. In principle this CANNOT happen unless some brain-dead has fiddled with the handled object directly.....

Note: The handle base corresponding to this object in for conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.

Author
M.Frank
Version
1.0

Definition at line 52 of file CartesianStripY.h.

Constructor & Destructor Documentation

◆ CartesianStripY() [1/5]

dd4hep::CartesianStripY::CartesianStripY ( )
default

Default constructor.

◆ CartesianStripY() [2/5]

dd4hep::CartesianStripY::CartesianStripY ( const CartesianStripY e)
default

Copy constructor.

◆ CartesianStripY() [3/5]

dd4hep::CartesianStripY::CartesianStripY ( const Segmentation e)
inline

Copy Constructor from segmentation base object.

Definition at line 59 of file CartesianStripY.h.

◆ CartesianStripY() [4/5]

dd4hep::CartesianStripY::CartesianStripY ( const Handle< Object > &  e)
inline

Copy constructor from handle.

Definition at line 61 of file CartesianStripY.h.

◆ CartesianStripY() [5/5]

template<typename Q >
dd4hep::CartesianStripY::CartesianStripY ( const Handle< Q > &  e)
inline

Copy constructor from other equivalent handle.

Definition at line 64 of file CartesianStripY.h.

Member Function Documentation

◆ cellDimensions()

std::vector< double > CartesianStripY::cellDimensions ( const CellID cellID) const

Returns a vector<double> of the cellDimensions of the given cell ID in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi.

Returns a vector of the cellDimensions of the given cell ID

Parameters
cellIDis ignored as all cells have the same dimension
Returns
std::vector<double> size 1:
  1. size in y

Definition at line 49 of file CartesianStripY.cpp.

◆ cellID()

dd4hep::CellID CartesianStripY::cellID ( const Position local,
const Position global,
const VolumeID volID 
) const

determine the cell ID based on the position

Definition at line 26 of file CartesianStripY.cpp.

◆ fieldNameY()

const std::string & CartesianStripY::fieldNameY ( ) const

access the field name used for Y

Definition at line 46 of file CartesianStripY.cpp.

◆ offsetY()

double CartesianStripY::offsetY ( ) const

access the coordinate offset in Y

Definition at line 40 of file CartesianStripY.cpp.

◆ operator=()

CartesianStripY& dd4hep::CartesianStripY::operator= ( const CartesianStripY seg)
default

Assignment operator.

◆ operator==()

bool dd4hep::CartesianStripY::operator== ( const CartesianStripY seg) const
inline

Equality operator.

Definition at line 68 of file CartesianStripY.h.

◆ position()

Position CartesianStripY::position ( const CellID cellID) const

determine the position based on the cell ID

Definition at line 21 of file CartesianStripY.cpp.

◆ setOffsetY()

void CartesianStripY::setOffsetY ( double  offset) const

set the coordinate offset in Y

Definition at line 43 of file CartesianStripY.cpp.

◆ setStripSizeY()

void CartesianStripY::setStripSizeY ( double  cellSize) const

set the strip size in Y

Definition at line 35 of file CartesianStripY.cpp.

◆ stripSizeY()

double CartesianStripY::stripSizeY ( ) const

access the strip size in Y

Definition at line 32 of file CartesianStripY.cpp.


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