Data implementation class of the Detector interface. More...

#include <DetectorData.h>

Inheritance diagram for dd4hep::DetectorData:

Classes
struct	InvalidObjectError
	Specialized exception class. More...

class	ObjectHandleMap
	Implementation of a map of named dd4hep Handles. More...

Public Member Functions
	DetectorData ()
	Default constructor. More...

virtual	~DetectorData ()
	Default destructor. More...

	DetectorData (DetectorData &&copy)=delete
	Move constructor. More...

	DetectorData (const DetectorData &copy)=delete
	Copy constructor. More...

void	destroyData (bool destroy_mgr=true)
	Clear data content: releases all allocated resources. More...

void	clearData ()
	Clear data content: DOES NOT RELEASEW ALLOCATED RESOURCES! More...

void	adoptData (DetectorData &source, bool CLR=true)
	Adopt all data from source structure. More...

TGeoManager &	manager () const
	Access the geometry manager of this instance. More...

dd4hep::Material	air () const
	Return handle to material describing air. More...

dd4hep::Material	vacuum () const
	Return handle to material describing vacuum. More...

dd4hep::VisAttr	invisible () const
	Return handle to "invisible" visualization attributes. More...

dd4hep::DetElement	world () const
	Return reference to the top-most (world) detector element. More...

dd4hep::DetElement	trackers () const
	Return reference to detector element with all tracker devices. More...

dd4hep::Volume	worldVolume () const
	Return handle to the world volume containing everything. More...

dd4hep::Volume	parallelWorldVolume () const
	Return handle to the world volume containing the volume with the tracking devices. More...

dd4hep::Volume	trackingVolume () const
	Return handle to the world volume containing the volume with the tracking devices. More...

dd4hep::VolumeManager	volumeManager () const
	Return handle to the VolumeManager. More...

dd4hep::OverlayedField	field () const
	Return handle to the combined electromagentic field description. More...

dd4hep::Header	header () const
	Accessor to the header entry. More...

const Detector::HandleMap &	constants () const
	Accessor to the map of constants. More...

const Detector::HandleMap &	visAttributes () const
	Accessor to the map of visualisation attributes. More...

const Detector::HandleMap &	limitsets () const
	Accessor to the map of limit settings. More...

const Detector::HandleMap &	regions () const
	Accessor to the map of region settings. More...

const Detector::HandleMap &	readouts () const
	Accessor to the map of readout structures. More...

const Detector::HandleMap &	detectors () const
	Accessor to the map of sub-detectors. More...

const Detector::HandleMap &	sensitiveDetectors () const
	Retrieve a sensitive detector by its name from the detector description. More...

const Detector::HandleMap &	fields () const
	Accessor to the map of field entries, which together form the global field. More...

const Detector::HandleMap &	idSpecifications () const
	Accessor to the map of ID specifications. More...

Static Public Member Functions
static void	patchRootStreamer (TClass *cl)
	Assignment operator. More...

static void	unpatchRootStreamer (TClass *cl)
	UNPatch the ROOT streamers to adapt for DD4hep (set fUserExtension transient) More...

Public Attributes
TGeoManager *	m_manager
	Reference to the geometry manager object from ROOT. More...

ObjectHandleMap	m_idDict
	Map of readout IDDescriptors indexed by hit collection name. More...

ObjectHandleMap	m_limits
	Map of limit sets. More...

ObjectHandleMap	m_regions
	Map of regions settings for the simulation. More...

ObjectHandleMap	m_readouts
	Map of readout descriptors indexed by subdetector name. More...

ObjectHandleMap	m_sensitive
	The map of top level sub-detector sensitive detector objects indexed by the detector name. More...

ObjectHandleMap	m_detectors
	The map of top level sub-detector objects indexed by name. More...

ObjectHandleMap	m_display
	The map of display attributes in use. More...

ObjectHandleMap	m_fields
	The map of electro magnet field components for the global overlay field. More...

ObjectHandleMap	m_define

std::map< std::string, DetElement >	m_detectorParents

DetElement	m_world

DetElement	m_trackers

Volume	m_worldVol

Volume	m_parallelWorldVol

Volume	m_trackingVol

Material	m_materialAir

Material	m_materialVacuum

VisAttr	m_invisibleVis

OverlayedField	m_field

Header	m_header

Detector::Properties	m_properties

DetectorBuildType	m_buildType

ObjectExtensions	m_extensions
	Definition of the extension type. More...

VolumeManager	m_volManager
	Volume manager reference. More...

Detector::State	m_state = Detector::NOT_READY
	Detector description state. More...

bool	m_inhibitConstants
	Flag to inhibit the access to global constants. Value set by constants section 'Detector_InhibitConstants'. More...

Detailed Description

Data implementation class of the Detector interface.

Author: M.Frank

Version: 1.0

Definition at line 38 of file DetectorData.h.

Constructor & Destructor Documentation

◆ DetectorData() [1/3]

DetectorData::DetectorData ( )

Default constructor.

Definition at line 159 of file DetectorData.cpp.

◆ ~DetectorData()

DetectorData::~DetectorData ( )

virtual

Default destructor.

Standard destructor.

Definition at line 181 of file DetectorData.cpp.

◆ DetectorData() [2/3]

dd4hep::DetectorData::DetectorData ( DetectorData && copy )

delete

Move constructor.

◆ DetectorData() [3/3]

dd4hep::DetectorData::DetectorData ( const DetectorData & copy )

delete

Copy constructor.

Member Function Documentation

◆ adoptData()

void DetectorData::adoptData	(	DetectorData &	source,
		bool	CLR = `true`
	)

Adopt all data from source structure.

Definition at line 283 of file DetectorData.cpp.

◆ air()

dd4hep::Material dd4hep::DetectorData::air ( ) const

inline

Return handle to material describing air.

Definition at line 175 of file DetectorData.h.

◆ clearData()

void DetectorData::clearData ( )

Clear data content: DOES NOT RELEASEW ALLOCATED RESOURCES!

Clear data content: releases all allocated resources.

Definition at line 255 of file DetectorData.cpp.

◆ constants()

const Detector::HandleMap& dd4hep::DetectorData::constants ( ) const

inline

Accessor to the map of constants.

Definition at line 197 of file DetectorData.h.

◆ destroyData()

void DetectorData::destroyData ( bool destroy_mgr = true )

Clear data content: releases all allocated resources.

Definition at line 209 of file DetectorData.cpp.

◆ detectors()

const Detector::HandleMap& dd4hep::DetectorData::detectors ( ) const

inline

Accessor to the map of sub-detectors.

Definition at line 207 of file DetectorData.h.

◆ field()

dd4hep::OverlayedField dd4hep::DetectorData::field ( ) const

inline

Return handle to the combined electromagentic field description.

Definition at line 193 of file DetectorData.h.

◆ fields()

const Detector::HandleMap& dd4hep::DetectorData::fields ( ) const

inline

Accessor to the map of field entries, which together form the global field.

Definition at line 211 of file DetectorData.h.

◆ header()

dd4hep::Header dd4hep::DetectorData::header ( ) const

inline

Accessor to the header entry.

Definition at line 195 of file DetectorData.h.

◆ idSpecifications()

const Detector::HandleMap& dd4hep::DetectorData::idSpecifications ( ) const

inline

Accessor to the map of ID specifications.

Definition at line 213 of file DetectorData.h.

◆ invisible()

dd4hep::VisAttr dd4hep::DetectorData::invisible ( ) const

inline

Return handle to "invisible" visualization attributes.

Definition at line 179 of file DetectorData.h.

◆ limitsets()

const Detector::HandleMap& dd4hep::DetectorData::limitsets ( ) const

inline

Accessor to the map of limit settings.

Definition at line 201 of file DetectorData.h.

◆ manager()

TGeoManager& dd4hep::DetectorData::manager ( ) const

inline

Access the geometry manager of this instance.

Definition at line 173 of file DetectorData.h.

◆ parallelWorldVolume()

dd4hep::Volume dd4hep::DetectorData::parallelWorldVolume ( ) const

inline

Return handle to the world volume containing the volume with the tracking devices.

Definition at line 187 of file DetectorData.h.

◆ patchRootStreamer()

void DetectorData::patchRootStreamer ( TClass * cl )

static

Assignment operator.

Patch the ROOT streamers to adapt for DD4hep.

Patch the ROOT streamers to adapt for DD4hep (set fUserExtension persistent)

Definition at line 187 of file DetectorData.cpp.

◆ readouts()

const Detector::HandleMap& dd4hep::DetectorData::readouts ( ) const

inline

Accessor to the map of readout structures.

Definition at line 205 of file DetectorData.h.

◆ regions()

const Detector::HandleMap& dd4hep::DetectorData::regions ( ) const

inline

Accessor to the map of region settings.

Definition at line 203 of file DetectorData.h.

◆ sensitiveDetectors()

const Detector::HandleMap& dd4hep::DetectorData::sensitiveDetectors ( ) const

inline

Retrieve a sensitive detector by its name from the detector description.

Definition at line 209 of file DetectorData.h.

◆ trackers()

dd4hep::DetElement dd4hep::DetectorData::trackers ( ) const

inline

Return reference to detector element with all tracker devices.

Definition at line 183 of file DetectorData.h.

◆ trackingVolume()

dd4hep::Volume dd4hep::DetectorData::trackingVolume ( ) const

inline

Return handle to the world volume containing the volume with the tracking devices.

Definition at line 189 of file DetectorData.h.

◆ unpatchRootStreamer()

void DetectorData::unpatchRootStreamer ( TClass * cl )

static

UNPatch the ROOT streamers to adapt for DD4hep (set fUserExtension transient)

UNPatch the ROOT streamers to adapt for DD4hep.

Definition at line 198 of file DetectorData.cpp.

◆ vacuum()

dd4hep::Material dd4hep::DetectorData::vacuum ( ) const

inline

Return handle to material describing vacuum.

Definition at line 177 of file DetectorData.h.

◆ visAttributes()

const Detector::HandleMap& dd4hep::DetectorData::visAttributes ( ) const

inline

Accessor to the map of visualisation attributes.

Definition at line 199 of file DetectorData.h.

◆ volumeManager()

dd4hep::VolumeManager dd4hep::DetectorData::volumeManager ( ) const

inline

Return handle to the VolumeManager.

Definition at line 191 of file DetectorData.h.

◆ world()

dd4hep::DetElement dd4hep::DetectorData::world ( ) const

inline

Return reference to the top-most (world) detector element.

Definition at line 181 of file DetectorData.h.

◆ worldVolume()

dd4hep::Volume dd4hep::DetectorData::worldVolume ( ) const

inline

Return handle to the world volume containing everything.

Definition at line 185 of file DetectorData.h.

Member Data Documentation

◆ m_buildType

DetectorBuildType dd4hep::DetectorData::m_buildType

Definition at line 134 of file DetectorData.h.

◆ m_define

ObjectHandleMap dd4hep::DetectorData::m_define

Definition at line 118 of file DetectorData.h.

◆ m_detectorParents

std::map<std::string,DetElement> dd4hep::DetectorData::m_detectorParents

Definition at line 120 of file DetectorData.h.

◆ m_detectors

ObjectHandleMap dd4hep::DetectorData::m_detectors

The map of top level sub-detector objects indexed by name.

Definition at line 112 of file DetectorData.h.

◆ m_display

ObjectHandleMap dd4hep::DetectorData::m_display

The map of display attributes in use.

Definition at line 114 of file DetectorData.h.

◆ m_extensions

ObjectExtensions dd4hep::DetectorData::m_extensions

Definition of the extension type.

Definition at line 137 of file DetectorData.h.

◆ m_field

OverlayedField dd4hep::DetectorData::m_field

Definition at line 131 of file DetectorData.h.

◆ m_fields

ObjectHandleMap dd4hep::DetectorData::m_fields

The map of electro magnet field components for the global overlay field.

Definition at line 116 of file DetectorData.h.

◆ m_header

Header dd4hep::DetectorData::m_header

Definition at line 132 of file DetectorData.h.

◆ m_idDict

ObjectHandleMap dd4hep::DetectorData::m_idDict

Map of readout IDDescriptors indexed by hit collection name.

Definition at line 102 of file DetectorData.h.

◆ m_inhibitConstants

bool dd4hep::DetectorData::m_inhibitConstants

Flag to inhibit the access to global constants. Value set by constants section 'Detector_InhibitConstants'.

Definition at line 145 of file DetectorData.h.

◆ m_invisibleVis

VisAttr dd4hep::DetectorData::m_invisibleVis

Definition at line 130 of file DetectorData.h.

◆ m_limits

ObjectHandleMap dd4hep::DetectorData::m_limits

Map of limit sets.

Definition at line 104 of file DetectorData.h.

◆ m_manager

TGeoManager* dd4hep::DetectorData::m_manager

Reference to the geometry manager object from ROOT.

All elments of the big detector description common block ;-0

Definition at line 100 of file DetectorData.h.

◆ m_materialAir

Material dd4hep::DetectorData::m_materialAir

Definition at line 128 of file DetectorData.h.

◆ m_materialVacuum

Material dd4hep::DetectorData::m_materialVacuum

Definition at line 129 of file DetectorData.h.

◆ m_parallelWorldVol

Volume dd4hep::DetectorData::m_parallelWorldVol

Definition at line 125 of file DetectorData.h.

◆ m_properties

Detector::Properties dd4hep::DetectorData::m_properties

Definition at line 133 of file DetectorData.h.

◆ m_readouts

ObjectHandleMap dd4hep::DetectorData::m_readouts

Map of readout descriptors indexed by subdetector name.

Definition at line 108 of file DetectorData.h.

◆ m_regions

ObjectHandleMap dd4hep::DetectorData::m_regions

Map of regions settings for the simulation.

Definition at line 106 of file DetectorData.h.

◆ m_sensitive

ObjectHandleMap dd4hep::DetectorData::m_sensitive

The map of top level sub-detector sensitive detector objects indexed by the detector name.

Definition at line 110 of file DetectorData.h.

◆ m_state

Detector::State dd4hep::DetectorData::m_state = Detector::NOT_READY

Detector description state.

Definition at line 142 of file DetectorData.h.

◆ m_trackers

DetElement dd4hep::DetectorData::m_trackers

Definition at line 123 of file DetectorData.h.

◆ m_trackingVol

Volume dd4hep::DetectorData::m_trackingVol

Definition at line 126 of file DetectorData.h.

◆ m_volManager

VolumeManager dd4hep::DetectorData::m_volManager

Volume manager reference.

Definition at line 139 of file DetectorData.h.

◆ m_world

DetElement dd4hep::DetectorData::m_world

Definition at line 122 of file DetectorData.h.

◆ m_worldVol

Volume dd4hep::DetectorData::m_worldVol

Definition at line 124 of file DetectorData.h.

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

DDCore/include/DD4hep/DetectorData.h
DDCore/src/DetectorData.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DetectorData() [1/3]

◆ ~DetectorData()

◆ DetectorData() [2/3]

◆ DetectorData() [3/3]

Member Function Documentation

◆ adoptData()

◆ air()

◆ clearData()

◆ constants()

◆ destroyData()

◆ detectors()

◆ field()

◆ fields()

◆ header()

◆ idSpecifications()

◆ invisible()

◆ limitsets()

◆ manager()

◆ parallelWorldVolume()

◆ patchRootStreamer()

◆ readouts()

◆ regions()

◆ sensitiveDetectors()

◆ trackers()

◆ trackingVolume()

◆ unpatchRootStreamer()

◆ vacuum()

◆ visAttributes()

◆ volumeManager()

◆ world()

◆ worldVolume()

Member Data Documentation

◆ m_buildType

◆ m_define

◆ m_detectorParents

◆ m_detectors

◆ m_display

◆ m_extensions

◆ m_field

◆ m_fields

◆ m_header

◆ m_idDict

◆ m_inhibitConstants

◆ m_invisibleVis

◆ m_limits

◆ m_manager

◆ m_materialAir

◆ m_materialVacuum

◆ m_parallelWorldVol

◆ m_properties

◆ m_readouts

◆ m_regions

◆ m_sensitive

◆ m_state

◆ m_trackers

◆ m_trackingVol

◆ m_volManager

◆ m_world

◆ m_worldVol