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

#include <Shapes.h>

Inheritance diagram for dd4hep::Tube:

Public Member Functions
	Tube ()=default
	Default constructor. More...

	Tube (Tube &&e)=default
	Move Constructor. More...

	Tube (const Tube &e)=default
	Copy Constructor. More...

template<typename Q >
	Tube (const Q *p)
	Constructor to be used with an existing object. More...

template<typename Q >
	Tube (const Handle< Q > &e)
	Constructor to assign an object. More...

	Tube (double rmin, double rmax, double dz)
	Constructor to create a new anonymous tube object with attribute initialization. More...

template<typename RMIN , typename RMAX , typename DZ >
	Tube (RMIN rmin, RMAX rmax, DZ dz)
	Constructor to create a new anonymous tube object with attribute initialization. More...

	Tube (double rmin, double rmax, double dz, double endPhi)
	Constructor to create a new anonymous tube object with attribute initialization. More...

template<typename RMIN , typename RMAX , typename DZ , typename ENDPHI >
	Tube (RMIN rmin, RMAX rmax, DZ dz, ENDPHI endPhi)
	Constructor to create a new anonymous tube object with attribute initialization. More...

	Tube (double rmin, double rmax, double dz, double startPhi, double endPhi)
	Constructor to create a new anonymous tube object with attribute initialization. More...

template<typename RMIN , typename RMAX , typename DZ , typename STARTPHI , typename ENDPHI >
	Tube (RMIN rmin, RMAX rmax, DZ dz, STARTPHI startPhi, ENDPHI endPhi)
	Constructor to create a new anonymous tube object with attribute initialization. More...

	Tube (const std::string &nam, double rmin, double rmax, double dz)
	Legacy: Constructor to create a new identifiable tube object with attribute initialization. More...

template<typename RMIN , typename RMAX , typename DZ >
	Tube (const std::string &nam, RMIN rmin, RMAX rmax, DZ dz)
	Constructor to create a new anonymous tube object with attribute initialization. More...

	Tube (const std::string &nam, double rmin, double rmax, double dz, double endPhi)
	Legacy: Constructor to create a new identifiable tube object with attribute initialization. More...

template<typename RMIN , typename RMAX , typename DZ , typename ENDPHI >
	Tube (const std::string &nam, RMIN rmin, RMAX rmax, DZ dz, ENDPHI endPhi)
	Constructor to create a new anonymous tube object with attribute initialization. More...

	Tube (const std::string &nam, double rmin, double rmax, double dz, double startPhi, double endPhi)
	Legacy: Constructor to create a new identifiable tube object with attribute initialization. More...

template<typename RMIN , typename RMAX , typename DZ , typename STARTPHI , typename ENDPHI >
	Tube (const std::string &nam, RMIN rmin, RMAX rmax, DZ dz, STARTPHI startPhi, ENDPHI endPhi)
	Constructor to create a new anonymous tube object with attribute initialization. More...

Tube &	operator= (Tube &&copy)=default
	Move Assignment operator. More...

Tube &	operator= (const Tube &copy)=default
	Copy Assignment operator. More...

Tube &	setDimensions (double rmin, double rmax, double dz, double startPhi=0.0, double endPhi=2 *M_PI)
	Set the tube 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	rMin () const
	Accessor: r-min value. More...

double	rMax () const
	Accessor: r-max value. 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_type &	operator= (Solid_type &&copy)=default
	Assignment move operator. More...

Solid_type &	operator= (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_type &	setDimensions (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 rmin, double rmax, double z, double startPhi, double endPhi)
	Internal helper method to support 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 tube shape of a section of a tube.

TGeoTube - cylindrical tube class. It takes 3 parameters : inner radius, outer radius and half-length 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 628 of file Shapes.h.

Constructor & Destructor Documentation

◆ Tube() [1/17]

dd4hep::Tube::Tube ( )

default

Default constructor.

◆ Tube() [2/17]

dd4hep::Tube::Tube ( Tube && e )

default

Move Constructor.

◆ Tube() [3/17]

dd4hep::Tube::Tube ( const Tube & e )

default

Copy Constructor.

◆ Tube() [4/17]

template<typename Q >

dd4hep::Tube::Tube ( const Q * p )

inline

Constructor to be used with an existing object.

Definition at line 641 of file Shapes.h.

◆ Tube() [5/17]

template<typename Q >

dd4hep::Tube::Tube ( const Handle< Q > & e )

inline

Constructor to assign an object.

Definition at line 643 of file Shapes.h.

◆ Tube() [6/17]

dd4hep::Tube::Tube	(	double	rmin,
		double	rmax,
		double	dz
	)

inline

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

Definition at line 646 of file Shapes.h.

◆ Tube() [7/17]

template<typename RMIN , typename RMAX , typename DZ >

dd4hep::Tube::Tube	(	RMIN	rmin,
		RMAX	rmax,
		DZ	dz
	)

inline

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

Definition at line 649 of file Shapes.h.

◆ Tube() [8/17]

dd4hep::Tube::Tube	(	double	rmin,
		double	rmax,
		double	dz,
		double	endPhi
	)

inline

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

Definition at line 652 of file Shapes.h.

◆ Tube() [9/17]

template<typename RMIN , typename RMAX , typename DZ , typename ENDPHI >

dd4hep::Tube::Tube	(	RMIN	rmin,
		RMAX	rmax,
		DZ	dz,
		ENDPHI	endPhi
	)

inline

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

Definition at line 656 of file Shapes.h.

◆ Tube() [10/17]

dd4hep::Tube::Tube	(	double	rmin,
		double	rmax,
		double	dz,
		double	startPhi,
		double	endPhi
	)

inline

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

Definition at line 659 of file Shapes.h.

◆ Tube() [11/17]

template<typename RMIN , typename RMAX , typename DZ , typename STARTPHI , typename ENDPHI >

dd4hep::Tube::Tube	(	RMIN	rmin,
		RMAX	rmax,
		DZ	dz,
		STARTPHI	startPhi,
		ENDPHI	endPhi
	)

inline

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

Definition at line 663 of file Shapes.h.

◆ Tube() [12/17]

dd4hep::Tube::Tube	(	const std::string &	nam,
		double	rmin,
		double	rmax,
		double	dz
	)

inline

Legacy: Constructor to create a new identifiable tube object with attribute initialization.

Definition at line 667 of file Shapes.h.

◆ Tube() [13/17]

template<typename RMIN , typename RMAX , typename DZ >

dd4hep::Tube::Tube	(	const std::string &	nam,
		RMIN	rmin,
		RMAX	rmax,
		DZ	dz
	)

inline

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

Definition at line 671 of file Shapes.h.

◆ Tube() [14/17]

dd4hep::Tube::Tube	(	const std::string &	nam,
		double	rmin,
		double	rmax,
		double	dz,
		double	endPhi
	)

inline

Legacy: Constructor to create a new identifiable tube object with attribute initialization.

Definition at line 674 of file Shapes.h.

◆ Tube() [15/17]

template<typename RMIN , typename RMAX , typename DZ , typename ENDPHI >

dd4hep::Tube::Tube	(	const std::string &	nam,
		RMIN	rmin,
		RMAX	rmax,
		DZ	dz,
		ENDPHI	endPhi
	)

inline

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

Definition at line 678 of file Shapes.h.

◆ Tube() [16/17]

dd4hep::Tube::Tube	(	const std::string &	nam,
		double	rmin,
		double	rmax,
		double	dz,
		double	startPhi,
		double	endPhi
	)

inline

Legacy: Constructor to create a new identifiable tube object with attribute initialization.

Definition at line 681 of file Shapes.h.

◆ Tube() [17/17]

template<typename RMIN , typename RMAX , typename DZ , typename STARTPHI , typename ENDPHI >

dd4hep::Tube::Tube	(	const std::string &	nam,
		RMIN	rmin,
		RMAX	rmax,
		DZ	dz,
		STARTPHI	startPhi,
		ENDPHI	endPhi
	)

inline

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

Definition at line 685 of file Shapes.h.

Member Function Documentation

◆ dZ()

double dd4hep::Tube::dZ ( ) const

inline

Accessor: delta-z value.

Definition at line 700 of file Shapes.h.

◆ endPhi()

double dd4hep::Tube::endPhi ( ) const

inline

Accessor: end-phi value.

Definition at line 698 of file Shapes.h.

◆ make()

void Tube::make	(	const std::string &	nam,
		double	rmin,
		double	rmax,
		double	z,
		double	startPhi,
		double	endPhi
	)

protected

Internal helper method to support object construction.

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

Definition at line 324 of file Shapes.cpp.

◆ operator=() [1/2]

Tube& dd4hep::Tube::operator= ( const Tube & copy )

default

Copy Assignment operator.

◆ operator=() [2/2]

Tube& dd4hep::Tube::operator= ( Tube && copy )

default

Move Assignment operator.

◆ rMax()

double dd4hep::Tube::rMax ( ) const

inline

Accessor: r-max value.

Definition at line 704 of file Shapes.h.

◆ rMin()

double dd4hep::Tube::rMin ( ) const

inline

Accessor: r-min value.

Definition at line 702 of file Shapes.h.

◆ setDimensions()

Tube & Tube::setDimensions	(	double	rmin,
		double	rmax,
		double	dz,
		double	startPhi = `0.0`,
		double	endPhi = `2*M_PI`
	)

Set the tube dimensions.

Definition at line 334 of file Shapes.cpp.

◆ startPhi()

double dd4hep::Tube::startPhi ( ) const

inline

Accessor: start-phi value.

Definition at line 696 of file Shapes.h.

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

DDCore/include/DD4hep/Shapes.h
DDCore/src/Shapes.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Tube() [1/17]

◆ Tube() [2/17]

◆ Tube() [3/17]

◆ Tube() [4/17]

◆ Tube() [5/17]

◆ Tube() [6/17]

◆ Tube() [7/17]

◆ Tube() [8/17]

◆ Tube() [9/17]

◆ Tube() [10/17]

◆ Tube() [11/17]

◆ Tube() [12/17]

◆ Tube() [13/17]

◆ Tube() [14/17]

◆ Tube() [15/17]

◆ Tube() [16/17]

◆ Tube() [17/17]

Member Function Documentation

◆ dZ()

◆ endPhi()

◆ make()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rMax()

◆ rMin()

◆ setDimensions()

◆ startPhi()