DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Types | Public Member Functions | List of all members
dd4hep::BorderSurface Class Reference

Class to support the handling of optical surfaces. More...

#include <OpticalSurfaces.h>

Inheritance diagram for dd4hep::BorderSurface:
dd4hep::Handle< TGeoBorderSurface >

Public Types

typedef TGeoBorderSurface Object
 
typedef const TGDMLMatrix * Property
 
- Public Types inherited from dd4hep::Handle< TGeoBorderSurface >
typedef TGeoBorderSurface Object
 Extern accessible definition of the contained element type. More...
 
typedef Handle< TGeoBorderSurface > Base
 Self type: used by sub-classes. More...
 

Public Member Functions

 BorderSurface ()=default
 Default constructor. More...
 
 BorderSurface (const BorderSurface &e)=default
 Copy constructor. More...
 
 BorderSurface (Object *obj)
 Constructor taking object pointer. More...
 
 BorderSurface (const Handle< Object > &e)
 Constructor from same-type handle. More...
 
template<typename Q >
 BorderSurface (const Handle< Q > &e)
 Constructor from arbitrary handle. More...
 
 BorderSurface (Detector &detector, DetElement de, const std::string &nam, OpticalSurface surf, PlacedVolume left, PlacedVolume right)
 Initializing constructor: Creates the object and registers it to the manager. More...
 
BorderSurfaceoperator= (const BorderSurface &m)=default
 Assignment operator. More...
 
OpticalSurface surface () const
 Access surface data. More...
 
Property property (const char *name) const
 Access to tabular properties of the optical surface. More...
 
Property property (const std::string &name) const
 Access to tabular properties of the optical surface. More...
 
PlacedVolume left () const
 Access the left node of the border surface. More...
 
PlacedVolume right () const
 Access the right node of the border surface. More...
 
- Public Member Functions inherited from dd4hep::Handle< TGeoBorderSurface >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< TGeoBorderSurface > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< TGeoBorderSurface > &element)=default
 Copy constructor. More...
 
 Handle (TGeoBorderSurface *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< TGeoBorderSurface > & operator= (Handle< TGeoBorderSurface > &&element)=default
 Assignment move operator. More...
 
Handle< TGeoBorderSurface > & operator= (const Handle< TGeoBorderSurface > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< TGeoBorderSurface > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< TGeoBorderSurface > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< TGeoBorderSurface > &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< TGeoBorderSurface > & clear ()
 Release the object held by the handle. More...
 
TGeoBorderSurface * operator-> () const
 Access the held object using the -> operator. More...
 
 operator TGeoBorderSurface & () const
 Automatic type conversion to an object references. More...
 
TGeoBorderSurface & operator* () const
 Access the held object using the * operator. More...
 
TGeoBorderSurface * 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...
 
TGeoBorderSurface * 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

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

Detailed Description

Class to support the handling of optical surfaces.

Author
M.Frank
Version
1.0

Definition at line 155 of file OpticalSurfaces.h.

Member Typedef Documentation

◆ Object

typedef TGeoBorderSurface dd4hep::BorderSurface::Object

Definition at line 157 of file OpticalSurfaces.h.

◆ Property

typedef const TGDMLMatrix* dd4hep::BorderSurface::Property

Definition at line 158 of file OpticalSurfaces.h.

Constructor & Destructor Documentation

◆ BorderSurface() [1/6]

dd4hep::BorderSurface::BorderSurface ( )
default

Default constructor.

◆ BorderSurface() [2/6]

dd4hep::BorderSurface::BorderSurface ( const BorderSurface e)
default

Copy constructor.

◆ BorderSurface() [3/6]

dd4hep::BorderSurface::BorderSurface ( Object obj)
inline

Constructor taking object pointer.

Definition at line 166 of file OpticalSurfaces.h.

◆ BorderSurface() [4/6]

dd4hep::BorderSurface::BorderSurface ( const Handle< Object > &  e)
inline

Constructor from same-type handle.

Definition at line 168 of file OpticalSurfaces.h.

◆ BorderSurface() [5/6]

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

Constructor from arbitrary handle.

Definition at line 171 of file OpticalSurfaces.h.

◆ BorderSurface() [6/6]

BorderSurface::BorderSurface ( Detector detector,
DetElement  de,
const std::string &  nam,
OpticalSurface  surf,
PlacedVolume  left,
PlacedVolume  right 
)

Initializing constructor: Creates the object and registers it to the manager.

Definition at line 96 of file OpticalSurfaces.cpp.

Member Function Documentation

◆ left()

PlacedVolume BorderSurface::left ( ) const

Access the left node of the border surface.

Definition at line 136 of file OpticalSurfaces.cpp.

◆ operator=()

BorderSurface& dd4hep::BorderSurface::operator= ( const BorderSurface m)
default

Assignment operator.

◆ property() [1/2]

BorderSurface::Property BorderSurface::property ( const char *  name) const

Access to tabular properties of the optical surface.

Definition at line 124 of file OpticalSurfaces.cpp.

◆ property() [2/2]

BorderSurface::Property BorderSurface::property ( const std::string &  name) const

Access to tabular properties of the optical surface.

Definition at line 130 of file OpticalSurfaces.cpp.

◆ right()

PlacedVolume BorderSurface::right ( ) const

Access the right node of the border surface.

Definition at line 141 of file OpticalSurfaces.cpp.

◆ surface()

OpticalSurface BorderSurface::surface ( ) const

Access surface data.

Definition at line 119 of file OpticalSurfaces.cpp.


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