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

Class describing a tube shape of a section of a cut tube segment. More...

#include <Shapes.h>

Inheritance diagram for dd4hep::CutTube:
dd4hep::Solid_type< TGeoCtub > dd4hep::Handle< TGeoCtub >

Public Member Functions

 CutTube ()=default
 Default constructor. More...
 
 CutTube (CutTube &&e)=default
 Move Constructor. More...
 
 CutTube (const CutTube &e)=default
 Copy Constructor. More...
 
template<typename Q >
 CutTube (const Q *p)
 Constructor to be used with an existing object. More...
 
template<typename Q >
 CutTube (const Handle< Q > &e)
 Constructor to assign an object. More...
 
 CutTube (double rmin, double rmax, double dz, double startPhi, double endPhi, double lx, double ly, double lz, double tx, double ty, double tz)
 Constructor to create a new cut-tube object with attribute initialization. More...
 
 CutTube (const std::string &name, double rmin, double rmax, double dz, double startPhi, double endPhi, double lx, double ly, double lz, double tx, double ty, double tz)
 Constructor to create a new identifiable cut-tube object with attribute initialization. More...
 
CutTubeoperator= (CutTube &&copy)=default
 Move Assignment operator. More...
 
CutTubeoperator= (const CutTube &copy)=default
 Copy Assignment operator. More...
 
double startPhi () const
 Accessor: start-phi value. More...
 
double endPhi () const
 Accessor: end-phi value. More...
 
double dZ () const
 Accessor: delta-z value. More...
 
double rMin () const
 Accessor: r-min value. More...
 
double rMax () const
 Accessor: r-max value. More...
 
std::vector< double > lowNormal () const
 Accessor: lower normal vector of cut plane. More...
 
std::vector< double > highNormal () const
 Accessor: upper normal vector of cut plane. More...
 
- Public Member Functions inherited from dd4hep::Solid_type< TGeoCtub >
 Solid_type ()=default
 Default constructor for uninitialized object. More...
 
 Solid_type (Solid_type &&e)=default
 Move constructor. More...
 
 Solid_type (const Solid_type &e)=default
 Copy constructor. More...
 
 Solid_type (TGeoCtub *p)
 Direct assignment using the implementation pointer. More...
 
 Solid_type (Handle< TGeoCtub > &&e)
 Move Constructor from handle. More...
 
 Solid_type (const Handle< TGeoCtub > &e)
 Copy Constructor from handle. More...
 
 Solid_type (const Handle< Q > &e)
 Constructor to be used when passing an already created object: need to check pointers. More...
 
Solid_typeoperator= (Solid_type &&copy)=default
 Assignment move operator. More...
 
Solid_typeoperator= (const Solid_type &copy)=default
 Assignment copy operator. More...
 
const char * name () const
 Access to shape name. More...
 
Solid_type< TGeoCtub > & setName (const char *value)
 Set new shape name. More...
 
Solid_type< TGeoCtub > & setName (const std::string &value)
 Set new shape name. More...
 
const char * title () const
 Access to shape title (GetTitle accessor of the TGeoShape) More...
 
const char * type () const
 Access to shape type (The TClass name of the ROOT implementation) More...
 
 operator TGeoCtub * () const
 Auto conversion to underlying ROOT object. More...
 
TGeoCtub * operator-> () const
 Overloaded operator -> to access underlying object. More...
 
std::vector< double > dimensions ()
 Access the dimensions of the shape: inverse of the setDimensions member function. More...
 
Solid_typesetDimensions (const std::vector< double > &params)
 Set the shape dimensions. As for the TGeo shape, but angles in rad rather than degrees. More...
 
std::string toString (int precision=2) const
 Conversion to string for pretty print. More...
 
TGeoVolume * divide (const Volume &voldiv, const std::string &divname, int iaxis, int ndiv, double start, double step) const
 Divide volume into subsections (See the ROOT manuloa for details) More...
 
- Public Member Functions inherited from dd4hep::Handle< TGeoCtub >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< TGeoCtub > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< TGeoCtub > &element)=default
 Copy constructor. More...
 
 Handle (TGeoCtub *element)
 Initializing constructor from pointer. More...
 
 Handle (Q *element)
 Initializing constructor from unrelated pointer with type checking. More...
 
 Handle (const Handle< Q > &element)
 Initializing constructor from unrelated handle with type checking. More...
 
Handle< TGeoCtub > & operator= (Handle< TGeoCtub > &&element)=default
 Assignment move operator. More...
 
Handle< TGeoCtub > & operator= (const Handle< TGeoCtub > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< TGeoCtub > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< TGeoCtub > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< TGeoCtub > &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< TGeoCtub > & clear ()
 Release the object held by the handle. More...
 
TGeoCtub * operator-> () const
 Access the held object using the -> operator. More...
 
 operator TGeoCtub & () const
 Automatic type conversion to an object references. More...
 
TGeoCtub & operator* () const
 Access the held object using the * operator. More...
 
TGeoCtub * ptr () const
 Access to the held object. More...
 
Q * _ptr () const
 Access to an unrelated object type. More...
 
Q * data () const
 Access to an unrelated object type. More...
 
Q & object () const
 Access to an unrelated object type. More...
 
TGeoCtub * 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...
 
const char * name () const
 
const char * name () const
 
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 assign (_Segmentation *s, const std::string &n, const std::string &)
 
void assign (NamedObject *p, const std::string &n, const std::string &t)
 
void destroy ()
 Destroy the underlying object (be careful here: things are not reference counted)! More...
 

Protected Member Functions

void make (const std::string &name, double rmin, double rmax, double dz, double startPhi, double endPhi, double lx, double ly, double lz, double tx, double ty, double tz)
 Internal helper method to support object construction. More...
 
- Protected Member Functions inherited from dd4hep::Solid_type< TGeoCtub >
void _setDimensions (double *param) const
 
void _assign (TGeoCtub *n, const std::string &nam, const std::string &tit, bool cbbox)
 Assign pointrs and register solid to geometry. More...
 

Additional Inherited Members

- Public Types inherited from dd4hep::Handle< TGeoCtub >
typedef TGeoCtub Object
 Extern accessible definition of the contained element type. More...
 
typedef Handle< TGeoCtub > Base
 Self type: used by sub-classes. More...
 
- Static Public Member Functions inherited from dd4hep::Handle< TGeoCtub >
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< TGeoCtub >
TGeoCtub * m_element
 Single and only data member: Reference to the actual element. More...
 

Detailed Description

Class describing a tube shape of a section of a cut tube segment.

For any further documentation please see the following ROOT documentation:

See also
http://root.cern.ch/root/html/TGeoCtub.html
Author
M.Frank
Version
1.0

Definition at line 716 of file Shapes.h.

Constructor & Destructor Documentation

◆ CutTube() [1/7]

dd4hep::CutTube::CutTube ( )
default

Default constructor.

◆ CutTube() [2/7]

dd4hep::CutTube::CutTube ( CutTube &&  e)
default

Move Constructor.

◆ CutTube() [3/7]

dd4hep::CutTube::CutTube ( const CutTube e)
default

Copy Constructor.

◆ CutTube() [4/7]

template<typename Q >
dd4hep::CutTube::CutTube ( const Q *  p)
inline

Constructor to be used with an existing object.

Definition at line 731 of file Shapes.h.

◆ CutTube() [5/7]

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

Constructor to assign an object.

Definition at line 733 of file Shapes.h.

◆ CutTube() [6/7]

CutTube::CutTube ( double  rmin,
double  rmax,
double  dz,
double  startPhi,
double  endPhi,
double  lx,
double  ly,
double  lz,
double  tx,
double  ty,
double  tz 
)

Constructor to create a new cut-tube object with attribute initialization.

Constructor to be used when creating a new object with attribute initialization.

Definition at line 341 of file Shapes.cpp.

◆ CutTube() [7/7]

CutTube::CutTube ( const std::string &  name,
double  rmin,
double  rmax,
double  dz,
double  startPhi,
double  endPhi,
double  lx,
double  ly,
double  lz,
double  tx,
double  ty,
double  tz 
)

Constructor to create a new identifiable cut-tube object with attribute initialization.

Constructor to be used when creating a new object with attribute initialization.

Definition at line 347 of file Shapes.cpp.

Member Function Documentation

◆ dZ()

double dd4hep::CutTube::dZ ( ) const
inline

Accessor: delta-z value.

Definition at line 754 of file Shapes.h.

◆ endPhi()

double dd4hep::CutTube::endPhi ( ) const
inline

Accessor: end-phi value.

Definition at line 752 of file Shapes.h.

◆ highNormal()

std::vector<double> dd4hep::CutTube::highNormal ( ) const
inline

Accessor: upper normal vector of cut plane.

Definition at line 762 of file Shapes.h.

◆ lowNormal()

std::vector<double> dd4hep::CutTube::lowNormal ( ) const
inline

Accessor: lower normal vector of cut plane.

Definition at line 760 of file Shapes.h.

◆ make()

void CutTube::make ( const std::string &  name,
double  rmin,
double  rmax,
double  dz,
double  startPhi,
double  endPhi,
double  lx,
double  ly,
double  lz,
double  tx,
double  ty,
double  tz 
)
protected

Internal helper method to support object construction.

Constructor to be used when creating a new object with attribute initialization.

Definition at line 354 of file Shapes.cpp.

◆ operator=() [1/2]

CutTube& dd4hep::CutTube::operator= ( const CutTube copy)
default

Copy Assignment operator.

◆ operator=() [2/2]

CutTube& dd4hep::CutTube::operator= ( CutTube &&  copy)
default

Move Assignment operator.

◆ rMax()

double dd4hep::CutTube::rMax ( ) const
inline

Accessor: r-max value.

Definition at line 758 of file Shapes.h.

◆ rMin()

double dd4hep::CutTube::rMin ( ) const
inline

Accessor: r-min value.

Definition at line 756 of file Shapes.h.

◆ startPhi()

double dd4hep::CutTube::startPhi ( ) const
inline

Accessor: start-phi value.

Definition at line 750 of file Shapes.h.


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