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

Class describing a cone segment shape. More...

#include <Shapes.h>

Inheritance diagram for dd4hep::ConeSegment:
dd4hep::Solid_type< TGeoConeSeg > dd4hep::Handle< TGeoConeSeg >

Public Member Functions

 ConeSegment ()=default
 Default constructor. More...
 
 ConeSegment (ConeSegment &&e)=default
 Move Constructor. More...
 
 ConeSegment (const ConeSegment &e)=default
 Copy Constructor. More...
 
template<typename Q >
 ConeSegment (const Q *p)
 Constructor to be used with an existing object. More...
 
template<typename Q >
 ConeSegment (const Handle< Q > &e)
 Constructor to be used when reading the already parsed ConeSegment object. More...
 
 ConeSegment (double dz, double rmin1, double rmax1, double rmin2, double rmax2, double startPhi=0.0, double endPhi=2.0 *M_PI)
 Constructor to create a new ConeSegment object. More...
 
template<typename DZ , typename RMIN1 , typename RMAX1 , typename RMIN2 , typename RMAX2 , typename STARTPHI , typename ENDPHI >
 ConeSegment (DZ dz, RMIN1 rmin1, RMAX1 rmax1, RMIN2 rmin2, RMAX2 rmax2, STARTPHI startPhi=0.0, ENDPHI endPhi=2.0 *M_PI)
 Constructor to create a new ConeSegment object. More...
 
 ConeSegment (const std::string &nam, double dz, double rmin1, double rmax1, double rmin2, double rmax2, double startPhi=0.0, double endPhi=2.0 *M_PI)
 Constructor to create a new named ConeSegment object. More...
 
template<typename DZ , typename RMIN1 , typename RMAX1 , typename RMIN2 , typename RMAX2 , typename STARTPHI , typename ENDPHI >
 ConeSegment (const std::string &nam, DZ dz, RMIN1 rmin1, RMAX1 rmax1, RMIN2 rmin2, RMAX2 rmax2, STARTPHI startPhi=0.0, ENDPHI endPhi=2.0 *M_PI)
 Constructor to create a new named ConeSegment object. More...
 
ConeSegmentoperator= (ConeSegment &&copy)=default
 Move Assignment operator. More...
 
ConeSegmentoperator= (const ConeSegment &copy)=default
 Copy Assignment operator. More...
 
ConeSegmentsetDimensions (double dz, double rmin1, double rmax1, double rmin2, double rmax2, double startPhi=0.0, double endPhi=2.0 *M_PI)
 Set the cone segment dimensions. 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 rMin1 () const
 Accessor: r-min-1 value. More...
 
double rMin2 () const
 Accessor: r-min-2 value. More...
 
double rMax1 () const
 Accessor: r-max-1 value. More...
 
double rMax2 () const
 Accessor: r-max-2 value. More...
 
- Public Member Functions inherited from dd4hep::Solid_type< TGeoConeSeg >
 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 (TGeoConeSeg *p)
 Direct assignment using the implementation pointer. More...
 
 Solid_type (Handle< TGeoConeSeg > &&e)
 Move Constructor from handle. More...
 
 Solid_type (const Handle< TGeoConeSeg > &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< TGeoConeSeg > & setName (const char *value)
 Set new shape name. More...
 
Solid_type< TGeoConeSeg > & 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 TGeoConeSeg * () const
 Auto conversion to underlying ROOT object. More...
 
TGeoConeSegoperator-> () 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< TGeoConeSeg >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< TGeoConeSeg > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< TGeoConeSeg > &element)=default
 Copy constructor. More...
 
 Handle (TGeoConeSeg *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< TGeoConeSeg > & operator= (Handle< TGeoConeSeg > &&element)=default
 Assignment move operator. More...
 
Handle< TGeoConeSeg > & operator= (const Handle< TGeoConeSeg > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< TGeoConeSeg > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< TGeoConeSeg > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< TGeoConeSeg > &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< TGeoConeSeg > & clear ()
 Release the object held by the handle. More...
 
TGeoConeSegoperator-> () const
 Access the held object using the -> operator. More...
 
 operator TGeoConeSeg & () const
 Automatic type conversion to an object references. More...
 
TGeoConeSegoperator* () const
 Access the held object using the * operator. More...
 
TGeoConeSegptr () 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...
 
TGeoConeSegaccess () 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...
 

Private Member Functions

void make (const std::string &name, double dz, double rmin1, double rmax1, double rmin2, double rmax2, double startPhi, double endPhi)
 Constructor to be used when creating a new cone segment object. More...
 

Additional Inherited Members

- Public Types inherited from dd4hep::Handle< TGeoConeSeg >
typedef TGeoConeSeg Object
 Extern accessible definition of the contained element type. More...
 
typedef Handle< TGeoConeSegBase
 Self type: used by sub-classes. More...
 
- Static Public Member Functions inherited from dd4hep::Handle< TGeoConeSeg >
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< TGeoConeSeg >
TGeoConeSegm_element
 Single and only data member: Reference to the actual element. More...
 
- Protected Member Functions inherited from dd4hep::Solid_type< TGeoConeSeg >
void _setDimensions (double *param) const
 
void _assign (TGeoConeSeg *n, const std::string &nam, const std::string &tit, bool cbbox)
 Assign pointrs and register solid to geometry. More...
 

Detailed Description

Class describing a cone segment shape.

A ConeSegment is, in the general case, a Phi segment of a cone, with half-length dz, inner and outer radii specified at -dz and +dz.

For any further documentation please see the following ROOT documentation:

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

Definition at line 542 of file Shapes.h.

Constructor & Destructor Documentation

◆ ConeSegment() [1/9]

dd4hep::ConeSegment::ConeSegment ( )
default

Default constructor.

◆ ConeSegment() [2/9]

dd4hep::ConeSegment::ConeSegment ( ConeSegment &&  e)
default

Move Constructor.

◆ ConeSegment() [3/9]

dd4hep::ConeSegment::ConeSegment ( const ConeSegment e)
default

Copy Constructor.

◆ ConeSegment() [4/9]

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

Constructor to be used with an existing object.

Definition at line 556 of file Shapes.h.

◆ ConeSegment() [5/9]

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

Constructor to be used when reading the already parsed ConeSegment object.

Definition at line 558 of file Shapes.h.

◆ ConeSegment() [6/9]

dd4hep::ConeSegment::ConeSegment ( double  dz,
double  rmin1,
double  rmax1,
double  rmin2,
double  rmax2,
double  startPhi = 0.0,
double  endPhi = 2.0 * M_PI 
)
inline

Constructor to create a new ConeSegment object.

Definition at line 561 of file Shapes.h.

◆ ConeSegment() [7/9]

template<typename DZ , typename RMIN1 , typename RMAX1 , typename RMIN2 , typename RMAX2 , typename STARTPHI , typename ENDPHI >
dd4hep::ConeSegment::ConeSegment ( DZ  dz,
RMIN1  rmin1,
RMAX1  rmax1,
RMIN2  rmin2,
RMAX2  rmax2,
STARTPHI  startPhi = 0.0,
ENDPHI  endPhi = 2.0 * M_PI 
)
inline

Constructor to create a new ConeSegment object.

Definition at line 569 of file Shapes.h.

◆ ConeSegment() [8/9]

dd4hep::ConeSegment::ConeSegment ( const std::string &  nam,
double  dz,
double  rmin1,
double  rmax1,
double  rmin2,
double  rmax2,
double  startPhi = 0.0,
double  endPhi = 2.0 * M_PI 
)
inline

Constructor to create a new named ConeSegment object.

Definition at line 576 of file Shapes.h.

◆ ConeSegment() [9/9]

template<typename DZ , typename RMIN1 , typename RMAX1 , typename RMIN2 , typename RMAX2 , typename STARTPHI , typename ENDPHI >
dd4hep::ConeSegment::ConeSegment ( const std::string &  nam,
DZ  dz,
RMIN1  rmin1,
RMAX1  rmax1,
RMIN2  rmin2,
RMAX2  rmax2,
STARTPHI  startPhi = 0.0,
ENDPHI  endPhi = 2.0 * M_PI 
)
inline

Constructor to create a new named ConeSegment object.

Definition at line 584 of file Shapes.h.

Member Function Documentation

◆ dZ()

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

Accessor: delta-z value.

Definition at line 605 of file Shapes.h.

◆ endPhi()

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

Accessor: end-phi value.

Definition at line 603 of file Shapes.h.

◆ make()

void ConeSegment::make ( const std::string &  name,
double  dz,
double  rmin1,
double  rmax1,
double  rmin2,
double  rmax2,
double  startPhi,
double  endPhi 
)
private

Constructor to be used when creating a new cone segment object.

Definition at line 291 of file Shapes.cpp.

◆ operator=() [1/2]

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

Move Assignment operator.

◆ operator=() [2/2]

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

Copy Assignment operator.

◆ rMax1()

double dd4hep::ConeSegment::rMax1 ( ) const
inline

Accessor: r-max-1 value.

Definition at line 611 of file Shapes.h.

◆ rMax2()

double dd4hep::ConeSegment::rMax2 ( ) const
inline

Accessor: r-max-2 value.

Definition at line 613 of file Shapes.h.

◆ rMin1()

double dd4hep::ConeSegment::rMin1 ( ) const
inline

Accessor: r-min-1 value.

Definition at line 607 of file Shapes.h.

◆ rMin2()

double dd4hep::ConeSegment::rMin2 ( ) const
inline

Accessor: r-min-2 value.

Definition at line 609 of file Shapes.h.

◆ setDimensions()

ConeSegment & ConeSegment::setDimensions ( double  dz,
double  rmin1,
double  rmax1,
double  rmin2,
double  rmax2,
double  startPhi = 0.0,
double  endPhi = 2.0 * M_PI 
)

Set the cone segment dimensions.

Definition at line 302 of file Shapes.cpp.

◆ startPhi()

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

Accessor: start-phi value.

Definition at line 601 of file Shapes.h.


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