Class describing a Polycone shape. More...

#include <Shapes.h>

Inheritance diagram for dd4hep::Polycone:

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

	Polycone (Polycone &&e)=default
	Move constructor. More...

	Polycone (const Polycone &e)=default
	Copy constructor. More...

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

template<typename Q >
	Polycone (const Handle< Q > &e)
	Constructor to be used when reading the already parsed polycone object. More...

	Polycone (double startPhi, double deltaPhi)
	Constructor to create a new polycone object. More...

	Polycone (double startPhi, double deltaPhi, const std::vector< double > &r, const std::vector< double > &z)
	Constructor to create a new polycone object. Add at the same time all Z planes. More...

	Polycone (double startPhi, double deltaPhi, const std::vector< double > &rmin, const std::vector< double > &rmax, const std::vector< double > &z)
	Constructor to create a new polycone object. Add at the same time all Z planes. More...

	Polycone (const std::string &name, double startPhi, double deltaPhi)
	Constructor to create a new named polycone object. More...

	Polycone (const std::string &name, double startPhi, double deltaPhi, const std::vector< double > &r, const std::vector< double > &z)
	Constructor to create a new named polycone object. Add at the same time all Z planes. More...

	Polycone (const std::string &name, double startPhi, double deltaPhi, const std::vector< double > &rmin, const std::vector< double > &rmax, const std::vector< double > &z)
	Constructor to create a new named polycone object. Add at the same time all Z planes. More...

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

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

void	addZPlanes (const std::vector< double > &rmin, const std::vector< double > &rmax, const std::vector< double > &z)
	Add Z-planes to the Polycone. More...

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

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

double	z (int which) const
	Accessor: z value. More...

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

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

std::vector< double >	zPlaneZ () const
	Accessor: vector of z-values for Z-planes value. More...

std::vector< double >	zPlaneRmin () const
	Accessor: vector of rMin-values for Z-planes value. More...

std::vector< double >	zPlaneRmax () const
	Accessor: vector of rMax-values for Z-planes value. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Additional Inherited Members
Public Types inherited from dd4hep::Handle< TGeoPcon >
typedef TGeoPcon	Object
	Extern accessible definition of the contained element type. More...

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

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

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

void	_assign (TGeoPcon *n, const std::string &nam, const std::string &tit, bool cbbox)
	Assign pointrs and register solid to geometry. More...

Detailed Description

Class describing a Polycone shape.

Polycone. It has at least 9 parameters :

the lower phi limit;
the range in phi;
the number of z planes (at least two) where the inner/outer radii are changing;
z coordinate, inner and outer radius for each z plane

For any further documentation please see the following ROOT documentation:

See also: http://root.cern.ch/root/html/TGeoPcon.html

Author: M.Frank

Version: 1.0

Definition at line 472 of file Shapes.h.

Constructor & Destructor Documentation

◆ Polycone() [1/11]

dd4hep::Polycone::Polycone ( )

default

Default constructor.

◆ Polycone() [2/11]

dd4hep::Polycone::Polycone ( Polycone && e )

default

Move constructor.

◆ Polycone() [3/11]

dd4hep::Polycone::Polycone ( const Polycone & e )

default

Copy constructor.

◆ Polycone() [4/11]

template<typename Q >

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

inline

Constructor to be used with an existing object.

Definition at line 481 of file Shapes.h.

◆ Polycone() [5/11]

template<typename Q >

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

inline

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

Definition at line 483 of file Shapes.h.

◆ Polycone() [6/11]

Polycone::Polycone	(	double	startPhi,
		double	deltaPhi
	)

Constructor to create a new polycone object.

Constructor to be used when creating a new object.

Definition at line 175 of file Shapes.cpp.

◆ Polycone() [7/11]

Polycone::Polycone	(	double	startPhi,
		double	deltaPhi,
		const std::vector< double > &	r,
		const std::vector< double > &	z
	)

Constructor to create a new polycone object. Add at the same time all Z planes.

Constructor to be used when creating a new polycone object. Add at the same time all Z planes.

Definition at line 201 of file Shapes.cpp.

◆ Polycone() [8/11]

Polycone::Polycone	(	double	startPhi,
		double	deltaPhi,
		const std::vector< double > &	rmin,
		const std::vector< double > &	rmax,
		const std::vector< double > &	z
	)

Constructor to create a new polycone object. Add at the same time all Z planes.

Constructor to be used when creating a new polycone object. Add at the same time all Z planes.

Definition at line 180 of file Shapes.cpp.

◆ Polycone() [9/11]

Polycone::Polycone	(	const std::string &	name,
		double	startPhi,
		double	deltaPhi
	)

Constructor to create a new named polycone object.

Constructor to be used when creating a new object.

Definition at line 221 of file Shapes.cpp.

◆ Polycone() [10/11]

Polycone::Polycone	(	const std::string &	name,
		double	startPhi,
		double	deltaPhi,
		const std::vector< double > &	r,
		const std::vector< double > &	z
	)

Constructor to create a new named polycone object. Add at the same time all Z planes.

Constructor to be used when creating a new polycone object. Add at the same time all Z planes.

Definition at line 247 of file Shapes.cpp.

◆ Polycone() [11/11]

Polycone::Polycone	(	const std::string &	name,
		double	startPhi,
		double	deltaPhi,
		const std::vector< double > &	rmin,
		const std::vector< double > &	rmax,
		const std::vector< double > &	z
	)

Constructor to create a new named polycone object. Add at the same time all Z planes.

Constructor to be used when creating a new polycone object. Add at the same time all Z planes.

Definition at line 226 of file Shapes.cpp.

Member Function Documentation

◆ addZPlanes()

void Polycone::addZPlanes	(	const std::vector< double > &	rmin,
		const std::vector< double > &	rmax,
		const std::vector< double > &	z
	)

Add Z-planes to the Polycone.

Definition at line 267 of file Shapes.cpp.

◆ deltaPhi()

double dd4hep::Polycone::deltaPhi ( ) const

inline

Accessor: delta-phi value.

Definition at line 514 of file Shapes.h.

◆ operator=() [1/2]

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

default

Copy Assignment operator.

◆ operator=() [2/2]

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

default

Move Assignment operator.

◆ rMax()

double dd4hep::Polycone::rMax ( int which ) const

inline

Accessor: r-max value.

Definition at line 521 of file Shapes.h.

◆ rMin()

double dd4hep::Polycone::rMin ( int which ) const

inline

Accessor: r-min value

Definition at line 519 of file Shapes.h.

◆ startPhi()

double dd4hep::Polycone::startPhi ( ) const

inline

Accessor: start-phi value.

Definition at line 512 of file Shapes.h.

◆ z()

double dd4hep::Polycone::z ( int which ) const

inline

Accessor: z value.

Definition at line 517 of file Shapes.h.

◆ zPlaneRmax()

std::vector<double> dd4hep::Polycone::zPlaneRmax ( ) const

inline

Accessor: vector of rMax-values for Z-planes value.

Definition at line 528 of file Shapes.h.

◆ zPlaneRmin()

std::vector<double> dd4hep::Polycone::zPlaneRmin ( ) const

inline

Accessor: vector of rMin-values for Z-planes value.

Definition at line 526 of file Shapes.h.

◆ zPlaneZ()

std::vector<double> dd4hep::Polycone::zPlaneZ ( ) const

inline

Accessor: vector of z-values for Z-planes value.

Definition at line 524 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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Polycone() [1/11]

◆ Polycone() [2/11]

◆ Polycone() [3/11]

◆ Polycone() [4/11]

◆ Polycone() [5/11]

◆ Polycone() [6/11]

◆ Polycone() [7/11]

◆ Polycone() [8/11]

◆ Polycone() [9/11]

◆ Polycone() [10/11]

◆ Polycone() [11/11]

Member Function Documentation

◆ addZPlanes()

◆ deltaPhi()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rMax()

◆ rMin()

◆ startPhi()

◆ z()

◆ zPlaneRmax()

◆ zPlaneRmin()

◆ zPlaneZ()