Class describing a Hyperboloid shape. More...

#include <Shapes.h>

Inheritance diagram for dd4hep::Hyperboloid:

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

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

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

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

template<typename Q >
	Hyperboloid (const Handle< Q > &e)
	Constructor to be used when passing an already created object. More...

	Hyperboloid (double rin, double stin, double rout, double stout, double dz)
	Constructor to create a new anonymous object with attribute initialization. More...

template<typename RIN , typename STIN , typename ROUT , typename STOUT , typename DZ >
	Hyperboloid (RIN rin, STIN stin, ROUT rout, STOUT stout, DZ dz)
	Constructor to create a new anonymous object with attribute initialization. More...

	Hyperboloid (const std::string &nam, double rin, double stin, double rout, double stout, double dz)
	Constructor to create a new identified object with attribute initialization. More...

template<typename RIN , typename STIN , typename ROUT , typename STOUT , typename DZ >
	Hyperboloid (const std::string &nam, RIN rin, STIN stin, ROUT rout, STOUT stout, DZ dz)
	Constructor to create a new identified object with attribute initialization. More...

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

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

Hyperboloid &	setDimensions (double rin, double stin, double rout, double stout, double dz)
	Set the Hyperboloid dimensions. 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...

double	stereoInner () const
	Stereo angle for inner surface. More...

double	stereoOuter () const
	Stereo angle for outer surface. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
void	make (const std::string &nam, double rin, double stin, double rout, double stout, double dz)
	Constructor function to create a new anonymous object with attribute initialization. More...

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

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

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

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

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

Detailed Description

Class describing a Hyperboloid shape.

For any further documentation please see the following ROOT documentation:

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

Author: M.Frank

Version: 1.0

Definition at line 1434 of file Shapes.h.

Constructor & Destructor Documentation

◆ Hyperboloid() [1/9]

dd4hep::Hyperboloid::Hyperboloid ( )

default

Default constructor.

◆ Hyperboloid() [2/9]

dd4hep::Hyperboloid::Hyperboloid ( Hyperboloid && e )

default

Move Constructor.

◆ Hyperboloid() [3/9]

dd4hep::Hyperboloid::Hyperboloid ( const Hyperboloid & e )

default

Copy Constructor.

◆ Hyperboloid() [4/9]

template<typename Q >

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

inline

Constructor to be used with an existing object.

Definition at line 1445 of file Shapes.h.

◆ Hyperboloid() [5/9]

template<typename Q >

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

inline

Constructor to be used when passing an already created object.

Definition at line 1447 of file Shapes.h.

◆ Hyperboloid() [6/9]

dd4hep::Hyperboloid::Hyperboloid	(	double	rin,
		double	stin,
		double	rout,
		double	stout,
		double	dz
	)

inline

Constructor to create a new anonymous object with attribute initialization.

Definition at line 1450 of file Shapes.h.

◆ Hyperboloid() [7/9]

template<typename RIN , typename STIN , typename ROUT , typename STOUT , typename DZ >

dd4hep::Hyperboloid::Hyperboloid	(	RIN	rin,
		STIN	stin,
		ROUT	rout,
		STOUT	stout,
		DZ	dz
	)

inline

Constructor to create a new anonymous object with attribute initialization.

Definition at line 1454 of file Shapes.h.

◆ Hyperboloid() [8/9]

dd4hep::Hyperboloid::Hyperboloid	(	const std::string &	nam,
		double	rin,
		double	stin,
		double	rout,
		double	stout,
		double	dz
	)

inline

Constructor to create a new identified object with attribute initialization.

Definition at line 1458 of file Shapes.h.

◆ Hyperboloid() [9/9]

template<typename RIN , typename STIN , typename ROUT , typename STOUT , typename DZ >

dd4hep::Hyperboloid::Hyperboloid	(	const std::string &	nam,
		RIN	rin,
		STIN	stin,
		ROUT	rout,
		STOUT	stout,
		DZ	dz
	)

inline

Constructor to create a new identified object with attribute initialization.

Definition at line 1462 of file Shapes.h.

Member Function Documentation

◆ dZ()

double dd4hep::Hyperboloid::dZ ( ) const

inline

Accessor: delta-z value.

Definition at line 1473 of file Shapes.h.

◆ make()

void Hyperboloid::make	(	const std::string &	nam,
		double	rin,
		double	stin,
		double	rout,
		double	stout,
		double	dz
	)

private

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

Constructor to create a new anonymous object with attribute initialization.

Definition at line 554 of file Shapes.cpp.

◆ operator=() [1/2]

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

default

Copy Assignment operator.

◆ operator=() [2/2]

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

default

Move Assignment operator.

◆ rMax()

double dd4hep::Hyperboloid::rMax ( ) const

inline

Accessor: r-max value.

Definition at line 1477 of file Shapes.h.

◆ rMin()

double dd4hep::Hyperboloid::rMin ( ) const

inline

Accessor: r-min value.

Definition at line 1475 of file Shapes.h.

◆ setDimensions()

Hyperboloid & Hyperboloid::setDimensions	(	double	rin,
		double	stin,
		double	rout,
		double	stout,
		double	dz
	)

Set the Hyperboloid dimensions.

Definition at line 559 of file Shapes.cpp.

◆ stereoInner()

double dd4hep::Hyperboloid::stereoInner ( ) const

inline

Stereo angle for inner surface.

Definition at line 1479 of file Shapes.h.

◆ stereoOuter()

double dd4hep::Hyperboloid::stereoOuter ( ) const

inline

Stereo angle for outer surface.

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

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Hyperboloid() [1/9]

◆ Hyperboloid() [2/9]

◆ Hyperboloid() [3/9]

◆ Hyperboloid() [4/9]

◆ Hyperboloid() [5/9]

◆ Hyperboloid() [6/9]

◆ Hyperboloid() [7/9]

◆ Hyperboloid() [8/9]

◆ Hyperboloid() [9/9]

Member Function Documentation

◆ dZ()

◆ make()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rMax()

◆ rMin()

◆ setDimensions()

◆ stereoInner()

◆ stereoOuter()