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

Class describing a Paraboloid shape. More...

#include <Shapes.h>

Inheritance diagram for dd4hep::Paraboloid:
dd4hep::Solid_type< TGeoParaboloid > dd4hep::Handle< TGeoParaboloid >

Public Member Functions

 Paraboloid ()=default
 Default constructor. More...
 
 Paraboloid (Paraboloid &&e)=default
 Move Constructor. More...
 
 Paraboloid (const Paraboloid &e)=default
 Copy Constructor. More...
 
template<typename Q >
 Paraboloid (const Q *p)
 Constructor to be used with an existing object. More...
 
template<typename Q >
 Paraboloid (const Handle< Q > &e)
 Constructor to be used when passing an already created object. More...
 
 Paraboloid (double r_low, double r_high, double delta_z)
 Constructor to create a new anonymous object with attribute initialization. More...
 
template<typename R_LOW , typename R_HIGH , typename DELTA_Z >
 Paraboloid (R_LOW r_low, R_HIGH r_high, DELTA_Z delta_z)
 Constructor to create a new anonymous object with attribute initialization. More...
 
 Paraboloid (const std::string &nam, double r_low, double r_high, double delta_z)
 Constructor to create a new identified object with attribute initialization. More...
 
template<typename R_LOW , typename R_HIGH , typename DELTA_Z >
 Paraboloid (const std::string &nam, R_LOW r_low, R_HIGH r_high, DELTA_Z delta_z)
 Constructor to create a new identified object with attribute initialization. More...
 
Paraboloidoperator= (Paraboloid &&copy)=default
 Move Assignment operator. More...
 
Paraboloidoperator= (const Paraboloid &copy)=default
 Copy Assignment operator. More...
 
ParaboloidsetDimensions (double r_low, double r_high, double delta_z)
 Set the Paraboloid dimensions. More...
 
double dZ () const
 Accessor: delta-z value. More...
 
double rLow () const
 Accessor: r-min value. More...
 
double rHigh () const
 Accessor: r-max value. More...
 
- Public Member Functions inherited from dd4hep::Solid_type< TGeoParaboloid >
 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 (TGeoParaboloid *p)
 Direct assignment using the implementation pointer. More...
 
 Solid_type (Handle< TGeoParaboloid > &&e)
 Move Constructor from handle. More...
 
 Solid_type (const Handle< TGeoParaboloid > &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< TGeoParaboloid > & setName (const char *value)
 Set new shape name. More...
 
Solid_type< TGeoParaboloid > & 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 TGeoParaboloid * () const
 Auto conversion to underlying ROOT object. More...
 
TGeoParaboloid * 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_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< TGeoParaboloid >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< TGeoParaboloid > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< TGeoParaboloid > &element)=default
 Copy constructor. More...
 
 Handle (TGeoParaboloid *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< TGeoParaboloid > & operator= (Handle< TGeoParaboloid > &&element)=default
 Assignment move operator. More...
 
Handle< TGeoParaboloid > & operator= (const Handle< TGeoParaboloid > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< TGeoParaboloid > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< TGeoParaboloid > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< TGeoParaboloid > &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< TGeoParaboloid > & clear ()
 Release the object held by the handle. More...
 
TGeoParaboloid * operator-> () const
 Access the held object using the -> operator. More...
 
 operator TGeoParaboloid & () const
 Automatic type conversion to an object references. More...
 
TGeoParaboloid & operator* () const
 Access the held object using the * operator. More...
 
TGeoParaboloid * 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...
 
TGeoParaboloid * 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 r_low, double r_high, double delta_z)
 Constructor function to create a new anonymous object with attribute initialization. More...
 

Additional Inherited Members

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

Detailed Description

Class describing a Paraboloid shape.

For any further documentation please see the following ROOT documentation:

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

Definition at line 1378 of file Shapes.h.

Constructor & Destructor Documentation

◆ Paraboloid() [1/9]

dd4hep::Paraboloid::Paraboloid ( )
default

Default constructor.

◆ Paraboloid() [2/9]

dd4hep::Paraboloid::Paraboloid ( Paraboloid &&  e)
default

Move Constructor.

◆ Paraboloid() [3/9]

dd4hep::Paraboloid::Paraboloid ( const Paraboloid e)
default

Copy Constructor.

◆ Paraboloid() [4/9]

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

Constructor to be used with an existing object.

Definition at line 1389 of file Shapes.h.

◆ Paraboloid() [5/9]

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

Constructor to be used when passing an already created object.

Definition at line 1391 of file Shapes.h.

◆ Paraboloid() [6/9]

dd4hep::Paraboloid::Paraboloid ( double  r_low,
double  r_high,
double  delta_z 
)
inline

Constructor to create a new anonymous object with attribute initialization.

Definition at line 1394 of file Shapes.h.

◆ Paraboloid() [7/9]

template<typename R_LOW , typename R_HIGH , typename DELTA_Z >
dd4hep::Paraboloid::Paraboloid ( R_LOW  r_low,
R_HIGH  r_high,
DELTA_Z  delta_z 
)
inline

Constructor to create a new anonymous object with attribute initialization.

Definition at line 1398 of file Shapes.h.

◆ Paraboloid() [8/9]

dd4hep::Paraboloid::Paraboloid ( const std::string &  nam,
double  r_low,
double  r_high,
double  delta_z 
)
inline

Constructor to create a new identified object with attribute initialization.

Definition at line 1402 of file Shapes.h.

◆ Paraboloid() [9/9]

template<typename R_LOW , typename R_HIGH , typename DELTA_Z >
dd4hep::Paraboloid::Paraboloid ( const std::string &  nam,
R_LOW  r_low,
R_HIGH  r_high,
DELTA_Z  delta_z 
)
inline

Constructor to create a new identified object with attribute initialization.

Definition at line 1406 of file Shapes.h.

Member Function Documentation

◆ dZ()

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

Accessor: delta-z value.

Definition at line 1417 of file Shapes.h.

◆ make()

void Paraboloid::make ( const std::string &  nam,
double  r_low,
double  r_high,
double  delta_z 
)
private

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

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

Definition at line 542 of file Shapes.cpp.

◆ operator=() [1/2]

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

Copy Assignment operator.

◆ operator=() [2/2]

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

Move Assignment operator.

◆ rHigh()

double dd4hep::Paraboloid::rHigh ( ) const
inline

Accessor: r-max value.

Definition at line 1421 of file Shapes.h.

◆ rLow()

double dd4hep::Paraboloid::rLow ( ) const
inline

Accessor: r-min value.

Definition at line 1419 of file Shapes.h.

◆ setDimensions()

Paraboloid & Paraboloid::setDimensions ( double  r_low,
double  r_high,
double  delta_z 
)

Set the Paraboloid dimensions.

Definition at line 547 of file Shapes.cpp.


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