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

Handle class to hold the information of the top DetElement object 'world'. More...

#include <World.h>

Inheritance diagram for dd4hep::World:
dd4hep::Handle< WorldObject >

Public Member Functions

 World ()=default
 Default constructor. More...
 
 World (const World &w)=default
 Copy from handle. More...
 
 World (const Handle< WorldObject > &o)
 Copy from named handle. More...
 
 World (Object *p)
 Copy from pointer. More...
 
template<typename Q >
 World (const Handle< Q > &e)
 Templated constructor for handle conversions. More...
 
Worldoperator= (const World &sd)=default
 Assignment operator. More...
 
DetectordetectorDescription () const
 Access the detector descrion tree. More...
 
- Public Member Functions inherited from dd4hep::Handle< WorldObject >
 Handle ()=default
 Default constructor. More...
 
 Handle (Handle< WorldObject > &&element)=default
 Copy constructor. More...
 
 Handle (const Handle< WorldObject > &element)=default
 Copy constructor. More...
 
 Handle (WorldObject *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< WorldObject > & operator= (Handle< WorldObject > &&element)=default
 Assignment move operator. More...
 
Handle< WorldObject > & operator= (const Handle< WorldObject > &element)=default
 Assignment copy operator. More...
 
bool operator== (const Handle< WorldObject > &element) const
 Boolean operator == used for RB tree insertions. More...
 
bool operator< (const Handle< WorldObject > &element) const
 Boolean operator < used for RB tree insertions. More...
 
bool operator> (const Handle< WorldObject > &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< WorldObject > & clear ()
 Release the object held by the handle. More...
 
WorldObjectoperator-> () const
 Access the held object using the -> operator. More...
 
 operator WorldObject & () const
 Automatic type conversion to an object references. More...
 
WorldObjectoperator* () const
 Access the held object using the * operator. More...
 
WorldObjectptr () 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...
 
WorldObjectaccess () 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< WorldObject >
typedef WorldObject Object
 Extern accessible definition of the contained element type. More...
 
typedef Handle< WorldObjectBase
 Self type: used by sub-classes. More...
 
- Static Public Member Functions inherited from dd4hep::Handle< WorldObject >
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< WorldObject >
WorldObjectm_element
 Single and only data member: Reference to the actual element. More...
 

Detailed Description

Handle class to hold the information of the top DetElement object 'world'.

Author
M.Frank
Version
1.0

Definition at line 31 of file World.h.

Constructor & Destructor Documentation

◆ World() [1/5]

dd4hep::World::World ( )
default

Default constructor.

◆ World() [2/5]

dd4hep::World::World ( const World w)
default

Copy from handle.

◆ World() [3/5]

dd4hep::World::World ( const Handle< WorldObject > &  o)
inline

Copy from named handle.

Definition at line 38 of file World.h.

◆ World() [4/5]

dd4hep::World::World ( Object p)
inline

Copy from pointer.

Definition at line 40 of file World.h.

◆ World() [5/5]

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

Templated constructor for handle conversions.

Definition at line 42 of file World.h.

Member Function Documentation

◆ detectorDescription()

dd4hep::Detector & dd4hep::World::detectorDescription ( ) const

Access the detector descrion tree.

Definition at line 19 of file World.cpp.

◆ operator=()

World& dd4hep::World::operator= ( const World sd)
default

Assignment operator.


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