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

Class describing a twisted tube shape. More...

#include <Shapes.h>

Inheritance diagram for dd4hep::TwistedTube:
dd4hep::Solid_type< TGeoTubeSeg > dd4hep::Handle< TGeoTubeSeg >

Public Member Functions

 TwistedTube ()=default
 Default constructor. More...
 
 TwistedTube (TwistedTube &&e)=default
 Move Constructor. More...
 
 TwistedTube (const TwistedTube &e)=default
 Copy Constructor. More...
 
template<typename Q >
 TwistedTube (const Q *p)
 Constructor to be used with an existing object. More...
 
template<typename Q >
 TwistedTube (const Handle< Q > &e)
 Constructor to assign an object. More...
 
 TwistedTube (double twist_angle, double rmin, double rmax, double dz, double dphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
 TwistedTube (double twist_angle, double rmin, double rmax, double dz, int nsegments, double totphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
 TwistedTube (double twist_angle, double rmin, double rmax, double zneg, double zpos, double totphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
 TwistedTube (double twist_angle, double rmin, double rmax, double zneg, double zpos, int nsegments, double totphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
 TwistedTube (const std::string &nam, double twist_angle, double rmin, double rmax, double dz, double dphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
 TwistedTube (const std::string &nam, double twist_angle, double rmin, double rmax, double dz, int nsegments, double totphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
 TwistedTube (const std::string &nam, double twist_angle, double rmin, double rmax, double zneg, double zpos, double totphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
 TwistedTube (const std::string &nam, double twist_angle, double rmin, double rmax, double zneg, double zpos, int nsegments, double totphi)
 Constructor to create a new anonymous tube object with attribute initialization. More...
 
template<typename A , typename B , typename DZ >
 TwistedTube (const std::string &nam, const A &a, const B &b, const DZ &dz)
 Constructor to create a new identified tube object with attribute initialization. More...
 
TwistedTubeoperator= (TwistedTube &&copy)=default
 Move Assignment operator. More...
 
TwistedTubeoperator= (const TwistedTube &copy)=default
 Copy Assignment operator. More...
 
TwistedTubesetDimensions (double a, double b, double dz)
 Set the tube dimensions. More...
 
- Public Member Functions inherited from dd4hep::Solid_type< TGeoTubeSeg >
 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 (TGeoTubeSeg *p)
 Direct assignment using the implementation pointer. More...
 
 Solid_type (Handle< TGeoTubeSeg > &&e)
 Move Constructor from handle. More...
 
 Solid_type (const Handle< TGeoTubeSeg > &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< TGeoTubeSeg > & setName (const char *value)
 Set new shape name. More...
 
Solid_type< TGeoTubeSeg > & 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 TGeoTubeSeg * () const
 Auto conversion to underlying ROOT object. More...
 
TGeoTubeSeg * 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< TGeoTubeSeg >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< TGeoTubeSeg > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< TGeoTubeSeg > &element)=default
 Copy constructor. More...
 
 Handle (TGeoTubeSeg *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< TGeoTubeSeg > & operator= (Handle< TGeoTubeSeg > &&element)=default
 Assignment move operator. More...
 
Handle< TGeoTubeSeg > & operator= (const Handle< TGeoTubeSeg > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< TGeoTubeSeg > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< TGeoTubeSeg > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< TGeoTubeSeg > &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< TGeoTubeSeg > & clear ()
 Release the object held by the handle. More...
 
TGeoTubeSeg * operator-> () const
 Access the held object using the -> operator. More...
 
 operator TGeoTubeSeg & () const
 Automatic type conversion to an object references. More...
 
TGeoTubeSeg & operator* () const
 Access the held object using the * operator. More...
 
TGeoTubeSeg * 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...
 
TGeoTubeSeg * 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 &nam, double twist_angle, double rmin, double rmax, double zneg, double zpos, int nsegments, double totphi)
 Internal helper method to support TwistedTube object construction. More...
 
- Protected Member Functions inherited from dd4hep::Solid_type< TGeoTubeSeg >
void _setDimensions (double *param) const
 
void _assign (TGeoTubeSeg *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< TGeoTubeSeg >
typedef TGeoTubeSeg Object
 Extern accessible definition of the contained element type. More...
 
typedef Handle< TGeoTubeSeg > Base
 Self type: used by sub-classes. More...
 
- Static Public Member Functions inherited from dd4hep::Handle< TGeoTubeSeg >
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< TGeoTubeSeg >
TGeoTubeSeg * m_element
 Single and only data member: Reference to the actual element. More...
 

Detailed Description

Class describing a twisted tube shape.

This is actually no TGeo shape. This implementation is a placeholder for the Geant4 implementation G4TwistedTube. In root it is implemented by a simple tube segment. When converted to geant4 it will become a G4TwistedTube.

Author
M.Frank
Version
1.0

Definition at line 900 of file Shapes.h.

Constructor & Destructor Documentation

◆ TwistedTube() [1/14]

dd4hep::TwistedTube::TwistedTube ( )
default

Default constructor.

◆ TwistedTube() [2/14]

dd4hep::TwistedTube::TwistedTube ( TwistedTube &&  e)
default

Move Constructor.

◆ TwistedTube() [3/14]

dd4hep::TwistedTube::TwistedTube ( const TwistedTube e)
default

Copy Constructor.

◆ TwistedTube() [4/14]

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

Constructor to be used with an existing object.

Definition at line 914 of file Shapes.h.

◆ TwistedTube() [5/14]

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

Constructor to assign an object.

Definition at line 916 of file Shapes.h.

◆ TwistedTube() [6/14]

dd4hep::TwistedTube::TwistedTube ( double  twist_angle,
double  rmin,
double  rmax,
double  dz,
double  dphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 919 of file Shapes.h.

◆ TwistedTube() [7/14]

dd4hep::TwistedTube::TwistedTube ( double  twist_angle,
double  rmin,
double  rmax,
double  dz,
int  nsegments,
double  totphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 923 of file Shapes.h.

◆ TwistedTube() [8/14]

dd4hep::TwistedTube::TwistedTube ( double  twist_angle,
double  rmin,
double  rmax,
double  zneg,
double  zpos,
double  totphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 927 of file Shapes.h.

◆ TwistedTube() [9/14]

dd4hep::TwistedTube::TwistedTube ( double  twist_angle,
double  rmin,
double  rmax,
double  zneg,
double  zpos,
int  nsegments,
double  totphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 931 of file Shapes.h.

◆ TwistedTube() [10/14]

dd4hep::TwistedTube::TwistedTube ( const std::string &  nam,
double  twist_angle,
double  rmin,
double  rmax,
double  dz,
double  dphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 936 of file Shapes.h.

◆ TwistedTube() [11/14]

dd4hep::TwistedTube::TwistedTube ( const std::string &  nam,
double  twist_angle,
double  rmin,
double  rmax,
double  dz,
int  nsegments,
double  totphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 940 of file Shapes.h.

◆ TwistedTube() [12/14]

dd4hep::TwistedTube::TwistedTube ( const std::string &  nam,
double  twist_angle,
double  rmin,
double  rmax,
double  zneg,
double  zpos,
double  totphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 944 of file Shapes.h.

◆ TwistedTube() [13/14]

dd4hep::TwistedTube::TwistedTube ( const std::string &  nam,
double  twist_angle,
double  rmin,
double  rmax,
double  zneg,
double  zpos,
int  nsegments,
double  totphi 
)
inline

Constructor to create a new anonymous tube object with attribute initialization.

Definition at line 948 of file Shapes.h.

◆ TwistedTube() [14/14]

template<typename A , typename B , typename DZ >
dd4hep::TwistedTube::TwistedTube ( const std::string &  nam,
const A &  a,
const B &  b,
const DZ &  dz 
)
inline

Constructor to create a new identified tube object with attribute initialization.

Definition at line 954 of file Shapes.h.

Member Function Documentation

◆ make()

void TwistedTube::make ( const std::string &  nam,
double  twist_angle,
double  rmin,
double  rmax,
double  zneg,
double  zpos,
int  nsegments,
double  totphi 
)
protected

Internal helper method to support TwistedTube object construction.

Definition at line 511 of file Shapes.cpp.

◆ operator=() [1/2]

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

Copy Assignment operator.

◆ operator=() [2/2]

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

Move Assignment operator.

◆ setDimensions()

TwistedTube& dd4hep::TwistedTube::setDimensions ( double  a,
double  b,
double  dz 
)

Set the tube dimensions.


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