Class describing a truncated tube shape (CMS'ism) More...

#include <Shapes.h>

Inheritance diagram for dd4hep::TruncatedTube:

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

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

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

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

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

	TruncatedTube (double dz, double rmin, double rmax, double startPhi, double deltaPhi, double cutAtStart, double cutAtDelta, bool cutInside)
	Constructor to create a truncated tube object with attribute initialization. More...

	TruncatedTube (const std::string &name, double dz, double rmin, double rmax, double startPhi, double deltaPhi, double cutAtStart, double cutAtDelta, bool cutInside)
	Constructor to create a truncated tube object with attribute initialization. More...

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

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

double	dZ () const
	Accessor: z-half value. More...

double	rMin () const
	Accessor: r-min value. More...

double	rMax () const
	Accessor: r-max value. More...

double	startPhi () const
	Accessor: start-phi value. More...

double	deltaPhi () const
	Accessor: delta-phi value. More...

double	cutAtStart () const
	Accessor: cut at start value. More...

double	cutAtDelta () const
	Accessor: cut at delta value. More...

bool	cutInside () const
	Accessor: cut-inside value. More...

Public Member Functions inherited from dd4hep::Solid_type< TGeoCompositeShape >
	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 (TGeoCompositeShape *p)
	Direct assignment using the implementation pointer. More...

	Solid_type (Handle< TGeoCompositeShape > &&e)
	Move Constructor from handle. More...

	Solid_type (const Handle< TGeoCompositeShape > &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< TGeoCompositeShape > &	setName (const char *value)
	Set new shape name. More...

Solid_type< TGeoCompositeShape > &	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 TGeoCompositeShape * () const
	Auto conversion to underlying ROOT object. More...

TGeoCompositeShape *	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< TGeoCompositeShape >
	Handle ()=default
	Default constructor. More...

	Handle (Handle< TGeoCompositeShape > &&element)=default
	Copy constructor. More...

	Handle (const Handle< TGeoCompositeShape > &element)=default
	Copy constructor. More...

	Handle (TGeoCompositeShape *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< TGeoCompositeShape > &	operator= (Handle< TGeoCompositeShape > &&element)=default
	Assignment move operator. More...

Handle< TGeoCompositeShape > &	operator= (const Handle< TGeoCompositeShape > &element)=default
	Assignment copy operator. More...

bool	operator== (const Handle< TGeoCompositeShape > &element) const
	Boolean operator == used for RB tree insertions. More...

bool	operator< (const Handle< TGeoCompositeShape > &element) const
	Boolean operator < used for RB tree insertions. More...

bool	operator> (const Handle< TGeoCompositeShape > &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< TGeoCompositeShape > &	clear ()
	Release the object held by the handle. More...

TGeoCompositeShape *	operator-> () const
	Access the held object using the -> operator. More...

	operator TGeoCompositeShape & () const
	Automatic type conversion to an object references. More...

TGeoCompositeShape &	operator* () const
	Access the held object using the * operator. More...

TGeoCompositeShape *	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...

TGeoCompositeShape *	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 dz, double rmin, double rmax, double startPhi, double deltaPhi, double cutAtStart, double cutAtDelta, bool cutInside)
	Internal helper method to support object construction. More...

Protected Member Functions inherited from dd4hep::Solid_type< TGeoCompositeShape >
void	_setDimensions (double *param) const

void	_assign (TGeoCompositeShape *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< TGeoCompositeShape >
typedef TGeoCompositeShape	Object
	Extern accessible definition of the contained element type. More...

typedef Handle< TGeoCompositeShape >	Base
	Self type: used by sub-classes. More...

Static Public Member Functions inherited from dd4hep::Handle< TGeoCompositeShape >
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< TGeoCompositeShape >
TGeoCompositeShape *	m_element
	Single and only data member: Reference to the actual element. More...

Detailed Description

Class describing a truncated tube shape (CMS'ism)

No real correspondance to TGeo. In principle it's a boolean Solid based on a tube.

See also: http://cmssdt.cern.ch/lxr/source/DetectorDescription/Core/src/TruncTubs.h

The Solid::dimension() and Solid::setDimension() calls for the TruncatedTube deliver/expect the parameters in the same order as the constructor: (dz, rmin, rmax, startPhi, deltaPhi, cutAtStart, cutAtDelta, cutInside)

Author: M.Frank

Version: 1.0

Definition at line 779 of file Shapes.h.

Constructor & Destructor Documentation

◆ TruncatedTube() [1/7]

dd4hep::TruncatedTube::TruncatedTube ( )

default

Default constructor.

◆ TruncatedTube() [2/7]

dd4hep::TruncatedTube::TruncatedTube ( TruncatedTube && e )

default

Move Constructor.

◆ TruncatedTube() [3/7]

dd4hep::TruncatedTube::TruncatedTube ( const TruncatedTube & e )

default

Copy Constructor.

◆ TruncatedTube() [4/7]

template<typename Q >

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

inline

Constructor to be used with an existing object.

Definition at line 794 of file Shapes.h.

◆ TruncatedTube() [5/7]

template<typename Q >

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

inline

Constructor to assign an object.

Definition at line 796 of file Shapes.h.

◆ TruncatedTube() [6/7]

TruncatedTube::TruncatedTube	(	double	dz,
		double	rmin,
		double	rmax,
		double	startPhi,
		double	deltaPhi,
		double	cutAtStart,
		double	cutAtDelta,
		bool	cutInside
	)

Constructor to create a truncated tube object with attribute initialization.

Definition at line 360 of file Shapes.cpp.

◆ TruncatedTube() [7/7]

TruncatedTube::TruncatedTube	(	const std::string &	name,
		double	dz,
		double	rmin,
		double	rmax,
		double	startPhi,
		double	deltaPhi,
		double	cutAtStart,
		double	cutAtDelta,
		bool	cutInside
	)

Constructor to create a truncated tube object with attribute initialization.

Definition at line 365 of file Shapes.cpp.

Member Function Documentation

◆ cutAtDelta()

double TruncatedTube::cutAtDelta ( ) const

Accessor: cut at delta value.

Definition at line 496 of file Shapes.cpp.

◆ cutAtStart()

double TruncatedTube::cutAtStart ( ) const

Accessor: cut at start value.

Definition at line 491 of file Shapes.cpp.

◆ cutInside()

bool TruncatedTube::cutInside ( ) const

Accessor: cut-inside value.

Definition at line 501 of file Shapes.cpp.

◆ deltaPhi()

double TruncatedTube::deltaPhi ( ) const

Accessor: delta-phi value.

Definition at line 486 of file Shapes.cpp.

◆ dZ()

double TruncatedTube::dZ ( ) const

Accessor: z-half value.

Accessor: dZ value.

Definition at line 466 of file Shapes.cpp.

◆ make()

void TruncatedTube::make	(	const std::string &	name,
		double	dz,
		double	rmin,
		double	rmax,
		double	startPhi,
		double	deltaPhi,
		double	cutAtStart,
		double	cutAtDelta,
		bool	cutInside
	)

protected

Internal helper method to support object construction.

Definition at line 371 of file Shapes.cpp.

◆ operator=() [1/2]

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

default

Copy Assignment operator.

◆ operator=() [2/2]

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

default

Move Assignment operator.

◆ rMax()

double TruncatedTube::rMax ( ) const

Accessor: r-max value.

Definition at line 476 of file Shapes.cpp.

◆ rMin()

double TruncatedTube::rMin ( ) const

Accessor: r-min value.

Definition at line 471 of file Shapes.cpp.

◆ startPhi()

double TruncatedTube::startPhi ( ) const

Accessor: start-phi value.

Definition at line 481 of file Shapes.cpp.

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

◆ TruncatedTube() [1/7]

◆ TruncatedTube() [2/7]

◆ TruncatedTube() [3/7]

◆ TruncatedTube() [4/7]

◆ TruncatedTube() [5/7]

◆ TruncatedTube() [6/7]

◆ TruncatedTube() [7/7]

Member Function Documentation

◆ cutAtDelta()

◆ cutAtStart()

◆ cutInside()

◆ deltaPhi()

◆ dZ()

◆ make()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rMax()

◆ rMin()

◆ startPhi()