Handle class describing a region as used in simulation. More...

#include <Objects.h>

Inheritance diagram for dd4hep::Region:

Public Member Functions
	Region ()=default
	Default constructor. More...

	Region (const Region &e)=default
	Copy Constructor. More...

	Region (const Handle< RegionObject > &e)
	Copy Constructor. More...

template<typename Q >
	Region (const Handle< Q > &e)
	Constructor to be used when assigning handle. More...

	Region (const std::string &name)
	Constructor to be used when creating a new object. More...

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

Region &	setStoreSecondaries (bool value)
	Set flag to store secondaries. More...

Region &	setThreshold (double value)
	Set threshold in MeV. More...

Region &	setCut (double value)
	Set default production cut. More...

Region &	setCut (double value, const std::string &particle)
	Set particle type specific cut (Geant4 accepts e+, e-, gamma, and proton) More...

std::vector< std::string > &	limits () const
	Access references to user limits. More...

double	cut () const
	Access cut value. More...

double	threshold () const
	Access production threshold. More...

bool	storeSecondaries () const
	Access secondaries flag. More...

bool	useDefaultCut () const
	Access use_default_cut flag. More...

bool	wasThresholdSet () const
	Access was_threshold_set flag. More...

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

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

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

	Handle (RegionObject *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< RegionObject > &	operator= (Handle< RegionObject > &&element)=default
	Assignment move operator. More...

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

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

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

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

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

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

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

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

RegionObject *	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
Public Types inherited from dd4hep::Handle< RegionObject >
typedef RegionObject	Object
	Extern accessible definition of the contained element type. More...

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

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

Detailed Description

Handle class describing a region as used in simulation.

Author: M.Frank

Version: 1.0

Definition at line 462 of file Objects.h.

Constructor & Destructor Documentation

◆ Region() [1/5]

dd4hep::Region::Region ( )

default

Default constructor.

◆ Region() [2/5]

dd4hep::Region::Region ( const Region & e )

default

Copy Constructor.

◆ Region() [3/5]

dd4hep::Region::Region ( const Handle< RegionObject > & e )

inline

Copy Constructor.

Definition at line 470 of file Objects.h.

◆ Region() [4/5]

template<typename Q >

dd4hep::Region::Region ( const Handle< Q > & e )

inline

Constructor to be used when assigning handle.

Definition at line 473 of file Objects.h.

◆ Region() [5/5]

Region::Region ( const std::string & name )

Constructor to be used when creating a new object.

Constructor to be used when creating a new DOM tree.

Definition at line 481 of file Objects.cpp.

Member Function Documentation

◆ cut()

double Region::cut ( ) const

Access cut value.

Definition at line 515 of file Objects.cpp.

◆ limits()

std::vector< std::string > & Region::limits ( ) const

Access references to user limits.

Definition at line 510 of file Objects.cpp.

◆ operator=()

Region& dd4hep::Region::operator= ( const Region & c )

default

Assignment operator.

◆ setCut() [1/2]

Region & Region::setCut ( double value )

Set default production cut.

Definition at line 503 of file Objects.cpp.

◆ setCut() [2/2]

Region& dd4hep::Region::setCut	(	double	value,
		const std::string &	particle
	)

Set particle type specific cut (Geant4 accepts e+, e-, gamma, and proton)

◆ setStoreSecondaries()

Region & Region::setStoreSecondaries ( bool value )

Set flag to store secondaries.

Definition at line 492 of file Objects.cpp.

◆ setThreshold()

Region & Region::setThreshold ( double value )

Set threshold in MeV.

Definition at line 497 of file Objects.cpp.

◆ storeSecondaries()

bool Region::storeSecondaries ( ) const

Access secondaries flag.

Definition at line 525 of file Objects.cpp.

◆ threshold()

double Region::threshold ( ) const

Access production threshold.

Definition at line 520 of file Objects.cpp.

◆ useDefaultCut()

bool Region::useDefaultCut ( ) const

Access use_default_cut flag.

Definition at line 529 of file Objects.cpp.

◆ wasThresholdSet()

bool Region::wasThresholdSet ( ) const

Access was_threshold_set flag.

Definition at line 533 of file Objects.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Region() [1/5]

◆ Region() [2/5]

◆ Region() [3/5]

◆ Region() [4/5]

◆ Region() [5/5]

Member Function Documentation

◆ cut()

◆ limits()

◆ operator=()

◆ setCut() [1/2]

◆ setCut() [2/2]

◆ setStoreSecondaries()

◆ setThreshold()

◆ storeSecondaries()

◆ threshold()

◆ useDefaultCut()

◆ wasThresholdSet()