The Geant4VolumeManager to facilitate optimized lookups of cell IDs from touchables. More...

#include <DDG4/Geant4VolumeManager.h>

Inheritance diagram for dd4hep::sim::Geant4VolumeManager:

Public Member Functions
	Geant4VolumeManager (const Detector &description, Geant4GeometryInfo *info)
	Initializing constructor. The tree will automatically be built if possible. More...

std::vector< const G4VPhysicalVolume * >	placementPath (const G4VTouchable *touchable, bool exception=true) const
	Helper: Generate placement path from touchable object. More...

VolumeID	volumeID (const G4VTouchable *touchable) const
	Access CELLID by Geant4 touchable object. More...

void	volumeDescriptor (const std::vector< const G4VPhysicalVolume * > &path, std::pair< VolumeID, std::vector< std::pair< const BitFieldElement *, VolumeID > > > &volume_desc) const
	Access fully decoded volume fields by placement path. More...

void	volumeDescriptor (const G4VTouchable touchable, std::pair< VolumeID, std::vector< std::pair< const BitFieldElement , VolumeID > > > &volume_desc) const
	Access fully decoded volume fields by Geant4 touchable object. More...

Public Member Functions inherited from dd4hep::Handle< T >
	Handle ()=default
	Default constructor. More...

	Handle (Handle< T > &&element)=default
	Copy constructor. More...

	Handle (const Handle< T > &element)=default
	Copy constructor. More...

	Handle (T *element)
	Initializing constructor from pointer. More...

template<typename Q >
	Handle (Q *element)
	Initializing constructor from unrelated pointer with type checking. More...

template<typename Q >
	Handle (const Handle< Q > &element)
	Initializing constructor from unrelated handle with type checking. More...

Handle< T > &	operator= (Handle< T > &&element)=default
	Assignment move operator. More...

Handle< T > &	operator= (const Handle< T > &element)=default
	Assignment copy operator. More...

bool	operator== (const Handle< T > &element) const
	Boolean operator == used for RB tree insertions. More...

bool	operator< (const Handle< T > &element) const
	Boolean operator < used for RB tree insertions. More...

bool	operator> (const Handle< T > &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< T > &	clear ()
	Release the object held by the handle. More...

T *	operator-> () const
	Access the held object using the -> operator. More...

	operator T& () const
	Automatic type conversion to an object references. More...

T &	operator* () const
	Access the held object using the * operator. More...

T *	ptr () const
	Access to the held object. More...

template<typename Q >
Q *	_ptr () const
	Access to an unrelated object type. More...

template<typename Q >
Q *	data () const
	Access to an unrelated object type. More...

template<typename Q >
Q &	object () const
	Access to an unrelated object type. More...

T *	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...

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	destroy ()
	Destroy the underlying object (be careful here: things are not reference counted)! More...

void	assign (_Segmentation *s, const std::string &n, const std::string &)

const char *	name () const

const char *	name () const

void	assign (NamedObject *p, const std::string &n, const std::string &t)

Static Public Attributes
static const VolumeID	InvalidPath = VolumeID(-1LL)

static const VolumeID	Insensitive = VolumeID(-2LL)

static const VolumeID	NonExisting = 0ULL

Protected Member Functions
bool	checkValidity () const
	Check the validity of the information before accessing it. More...

	Geant4VolumeManager ()=default
	Default constructor. More...

	Geant4VolumeManager (const Handle< Geant4GeometryInfo > &e)
	Constructor to be used when reading the already parsed object. More...

	Geant4VolumeManager (const Geant4VolumeManager &e)=default
	Constructor to be used when reading the already parsed object. More...

template<typename Q >
	Geant4VolumeManager (const Handle< Q > &e)
	Constructor to be used when reading the already parsed object. More...

Geant4VolumeManager &	operator= (const Geant4VolumeManager &c)=default
	Assignment operator. More...

Friends
class	Geant4Mapping

Additional Inherited Members
Public Types inherited from dd4hep::Handle< T >
typedef T	Object
	Extern accessible definition of the contained element type. More...

typedef Handle< T >	Base
	Self type: used by sub-classes. More...

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

Detailed Description

The Geant4VolumeManager to facilitate optimized lookups of cell IDs from touchables.

Author: M.Frank

Version: 1.0

Definition at line 47 of file Geant4VolumeManager.h.

Constructor & Destructor Documentation

◆ Geant4VolumeManager() [1/5]

dd4hep::sim::Geant4VolumeManager::Geant4VolumeManager ( )

protecteddefault

Default constructor.

◆ Geant4VolumeManager() [2/5]

dd4hep::sim::Geant4VolumeManager::Geant4VolumeManager ( const Handle< Geant4GeometryInfo > & e )

inlineprotected

Constructor to be used when reading the already parsed object.

Definition at line 57 of file Geant4VolumeManager.h.

◆ Geant4VolumeManager() [3/5]

dd4hep::sim::Geant4VolumeManager::Geant4VolumeManager ( const Geant4VolumeManager & e )

protecteddefault

Constructor to be used when reading the already parsed object.

◆ Geant4VolumeManager() [4/5]

template<typename Q >

dd4hep::sim::Geant4VolumeManager::Geant4VolumeManager ( const Handle< Q > & e )

inlineprotected

Constructor to be used when reading the already parsed object.

Definition at line 62 of file Geant4VolumeManager.h.

◆ Geant4VolumeManager() [5/5]

Geant4VolumeManager::Geant4VolumeManager	(	const Detector &	description,
		Geant4GeometryInfo *	info
	)

Initializing constructor. The tree will automatically be built if possible.

Definition at line 282 of file Geant4VolumeManager.cpp.

Member Function Documentation

◆ checkValidity()

bool Geant4VolumeManager::checkValidity ( ) const

protected

Check the validity of the information before accessing it.

Definition at line 303 of file Geant4VolumeManager.cpp.

◆ operator=()

Geant4VolumeManager& dd4hep::sim::Geant4VolumeManager::operator= ( const Geant4VolumeManager & c )

protecteddefault

Assignment operator.

◆ placementPath()

std::vector< const G4VPhysicalVolume * > Geant4VolumeManager::placementPath	(	const G4VTouchable *	touchable,
		bool	exception = `true`
	)		const

Helper: Generate placement path from touchable object.

Definition at line 297 of file Geant4VolumeManager.cpp.

◆ volumeDescriptor() [1/2]

void dd4hep::sim::Geant4VolumeManager::volumeDescriptor	(	const G4VTouchable *	touchable,
		std::pair< VolumeID, std::vector< std::pair< const BitFieldElement *, VolumeID > > > &	volume_desc
	)		const

Access fully decoded volume fields by Geant4 touchable object.

◆ volumeDescriptor() [2/2]

void dd4hep::sim::Geant4VolumeManager::volumeDescriptor	(	const std::vector< const G4VPhysicalVolume * > &	path,
		std::pair< VolumeID, std::vector< std::pair< const BitFieldElement *, VolumeID > > > &	volume_desc
	)		const

Access fully decoded volume fields by placement path.

◆ volumeID()

VolumeID Geant4VolumeManager::volumeID ( const G4VTouchable * touchable ) const

Access CELLID by Geant4 touchable object.

No parametrization or replication.

This is incredibly slow .... but what can I do ? Need a better idea.

Definition at line 327 of file Geant4VolumeManager.cpp.

Friends And Related Function Documentation

◆ Geant4Mapping

friend class Geant4Mapping

friend

Definition at line 52 of file Geant4VolumeManager.h.

Member Data Documentation

◆ Insensitive

const VolumeID dd4hep::sim::Geant4VolumeManager::Insensitive = VolumeID(-2LL)

static

Definition at line 70 of file Geant4VolumeManager.h.

◆ InvalidPath

const VolumeID dd4hep::sim::Geant4VolumeManager::InvalidPath = VolumeID(-1LL)

static

Definition at line 69 of file Geant4VolumeManager.h.

◆ NonExisting

const VolumeID dd4hep::sim::Geant4VolumeManager::NonExisting = 0ULL

static

Definition at line 71 of file Geant4VolumeManager.h.

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

DDG4/include/DDG4/Geant4VolumeManager.h
DDG4/src/Geant4VolumeManager.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geant4VolumeManager() [1/5]

◆ Geant4VolumeManager() [2/5]

◆ Geant4VolumeManager() [3/5]

◆ Geant4VolumeManager() [4/5]

◆ Geant4VolumeManager() [5/5]

Member Function Documentation

◆ checkValidity()

◆ operator=()

◆ placementPath()

◆ volumeDescriptor() [1/2]

◆ volumeDescriptor() [2/2]

◆ volumeID()

Friends And Related Function Documentation

◆ Geant4Mapping

Member Data Documentation

◆ Insensitive

◆ InvalidPath

◆ NonExisting