DD4hep  1.28.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Member Functions | List of all members

Class describing a Scale shape. More...

#include <Shapes.h>

Inheritance diagram for dd4hep::Scale:
dd4hep::Solid_type< TGeoScaledShape > dd4hep::Handle< TGeoScaledShape >

Public Member Functions

 Scale ()=default
 Default constructor. More...
 
 Scale (Scale &&e)=default
 Move constructor. More...
 
 Scale (const Scale &e)=default
 Copy constructor. More...
 
template<typename Q >
 Scale (const Q *p)
 Constructor to be used with an existing object. More...
 
template<typename Q >
 Scale (const Handle< Q > &e)
 Copy Constructor to be used with an existing object handle. More...
 
 Scale (Solid base_solid, double x_scale, double y_scale, double z_scale)
 Constructor to create an anonymous new Scale object (retrieves name from volume) More...
 
 Scale (const std::string &nam, Solid base_solid, double x_scale, double y_scale, double z_scale)
 Constructor to create a named new Scale object (retrieves name from volume) More...
 
template<typename X , typename Y , typename Z >
 Scale (Solid base_solid, const X &x_scale, const Y &y_scale, const Z &z_scale)
 Constructor to create an anonymous new Scale object (retrieves name from volume) More...
 
template<typename X , typename Y , typename Z >
 Scale (const std::string &nam, Solid base_solid, const X &x_scale, const Y &y_scale, const Z &z_scale)
 Constructor to create a named new Scale object (retrieves name from volume) More...
 
Scaleoperator= (Scale &&copy)=default
 Move Assignment operator. More...
 
Scaleoperator= (const Scale &copy)=default
 Copy Assignment operator. More...
 
double scale_x () const
 Access x-scale factor. More...
 
double scale_y () const
 Access y-scale factor. More...
 
double scale_z () const
 Access z-scale factor. More...
 
- Public Member Functions inherited from dd4hep::Solid_type< TGeoScaledShape >
 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 (TGeoScaledShape *p)
 Direct assignment using the implementation pointer. More...
 
 Solid_type (Handle< TGeoScaledShape > &&e)
 Move Constructor from handle. More...
 
 Solid_type (const Handle< TGeoScaledShape > &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< TGeoScaledShape > & setName (const char *value)
 Set new shape name. More...
 
Solid_type< TGeoScaledShape > & 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 TGeoScaledShape * () const
 Auto conversion to underlying ROOT object. More...
 
TGeoScaledShape * 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< TGeoScaledShape >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< TGeoScaledShape > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< TGeoScaledShape > &element)=default
 Copy constructor. More...
 
 Handle (TGeoScaledShape *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< TGeoScaledShape > & operator= (Handle< TGeoScaledShape > &&element)=default
 Assignment move operator. More...
 
Handle< TGeoScaledShape > & operator= (const Handle< TGeoScaledShape > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< TGeoScaledShape > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< TGeoScaledShape > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< TGeoScaledShape > &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< TGeoScaledShape > & clear ()
 Release the object held by the handle. More...
 
TGeoScaledShape * operator-> () const
 Access the held object using the -> operator. More...
 
 operator TGeoScaledShape & () const
 Automatic type conversion to an object references. More...
 
TGeoScaledShape & operator* () const
 Access the held object using the * operator. More...
 
TGeoScaledShape * 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...
 
TGeoScaledShape * 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, Solid base_solid, double x_scale, double y_scale, double z_scale)
 Internal helper method to support object construction. More...
 
- Protected Member Functions inherited from dd4hep::Solid_type< TGeoScaledShape >
void _setDimensions (double *param) const
 
void _assign (TGeoScaledShape *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< TGeoScaledShape >
typedef TGeoScaledShape Object
 Extern accessible definition of the contained element type. More...
 
typedef Handle< TGeoScaledShape > Base
 Self type: used by sub-classes. More...
 
- Static Public Member Functions inherited from dd4hep::Handle< TGeoScaledShape >
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< TGeoScaledShape >
TGeoScaledShape * m_element
 Single and only data member: Reference to the actual element. More...
 

Detailed Description

Class describing a Scale shape.

For any further documentation please see the following ROOT documentation:

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

Definition at line 239 of file Shapes.h.

Constructor & Destructor Documentation

◆ Scale() [1/9]

dd4hep::Scale::Scale ( )
default

Default constructor.

◆ Scale() [2/9]

dd4hep::Scale::Scale ( Scale &&  e)
default

Move constructor.

◆ Scale() [3/9]

dd4hep::Scale::Scale ( const Scale e)
default

Copy constructor.

◆ Scale() [4/9]

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

Constructor to be used with an existing object.

Definition at line 252 of file Shapes.h.

◆ Scale() [5/9]

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

Copy Constructor to be used with an existing object handle.

Definition at line 254 of file Shapes.h.

◆ Scale() [6/9]

dd4hep::Scale::Scale ( Solid  base_solid,
double  x_scale,
double  y_scale,
double  z_scale 
)
inline

Constructor to create an anonymous new Scale object (retrieves name from volume)

Definition at line 257 of file Shapes.h.

◆ Scale() [7/9]

dd4hep::Scale::Scale ( const std::string &  nam,
Solid  base_solid,
double  x_scale,
double  y_scale,
double  z_scale 
)
inline

Constructor to create a named new Scale object (retrieves name from volume)

Definition at line 260 of file Shapes.h.

◆ Scale() [8/9]

template<typename X , typename Y , typename Z >
dd4hep::Scale::Scale ( Solid  base_solid,
const X &  x_scale,
const Y &  y_scale,
const Z &  z_scale 
)
inline

Constructor to create an anonymous new Scale object (retrieves name from volume)

Definition at line 265 of file Shapes.h.

◆ Scale() [9/9]

template<typename X , typename Y , typename Z >
dd4hep::Scale::Scale ( const std::string &  nam,
Solid  base_solid,
const X &  x_scale,
const Y &  y_scale,
const Z &  z_scale 
)
inline

Constructor to create a named new Scale object (retrieves name from volume)

Definition at line 269 of file Shapes.h.

Member Function Documentation

◆ make()

void Scale::make ( const std::string &  name,
Solid  base_solid,
double  x_scale,
double  y_scale,
double  z_scale 
)
protected

Internal helper method to support object construction.

Definition at line 123 of file Shapes.cpp.

◆ operator=() [1/2]

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

Copy Assignment operator.

◆ operator=() [2/2]

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

Move Assignment operator.

◆ scale_x()

double Scale::scale_x ( ) const

Access x-scale factor.

Definition at line 129 of file Shapes.cpp.

◆ scale_y()

double Scale::scale_y ( ) const

Access y-scale factor.

Definition at line 134 of file Shapes.cpp.

◆ scale_z()

double Scale::scale_z ( ) const

Access z-scale factor.

Definition at line 139 of file Shapes.cpp.


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