Handle class describing a material. More...

#include <Objects.h>

Inheritance diagram for dd4hep::Material:

Public Types
typedef const TGDMLMatrix *	Property

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

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

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

	Material (const Material &copy)=default
	Copy constructor. More...

	Material (Object *e)
	Initialization from pointer. More...

	Material (const Handle< Object > &e)
	Constructorto be used for assignment from material handle. More...

template<typename Q >
	Material (const Handle< Q > &e)
	Constructorto be used for assignment from object handle. More...

Material &	operator= (const Material &copy)=default
	Assignment operator. More...

double	Z () const
	proton number of the underlying material More...

double	A () const
	atomic number of the underlying material More...

double	density () const
	density of the underlying material More...

std::string	toString () const
	String representation of this object. More...

double	radLength () const
	Access the radiation length of the underlying material. More...

double	intLength () const
	Access the interaction length of the underlying material. More...

double	fraction (Atom atom) const
	Access the fraction of an element within the material. More...

Property	property (const char *name) const
	Access to tabular properties of the material. More...

Property	property (const std::string &name) const
	Access to tabular properties of the material. More...

std::string	propertyRef (const std::string &name, const std::string &default_value="")
	Access string property value from the material table. More...

double	constProperty (const std::string &name) const
	Access to tabular properties of the material. More...

std::string	constPropertyRef (const std::string &name, const std::string &default_value="")
	Access string property value from the material table. More...

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

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

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

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

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

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

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

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

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

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

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

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

TGeoMedium *	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< TGeoMedium >
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< TGeoMedium >
TGeoMedium *	m_element
	Single and only data member: Reference to the actual element. More...

Detailed Description

Handle class describing a material.

For details please see the ROOT TGeo information:

See also: http://root.cern.ch/root/html/TGeoMedium.html

Author: M.Frank

Version: 1.0

Definition at line 271 of file Objects.h.

Member Typedef Documentation

◆ Property

typedef const TGDMLMatrix* dd4hep::Material::Property

Definition at line 273 of file Objects.h.

Constructor & Destructor Documentation

◆ Material() [1/5]

dd4hep::Material::Material ( )

default

Default constructor.

◆ Material() [2/5]

dd4hep::Material::Material ( const Material & copy )

default

Copy constructor.

◆ Material() [3/5]

dd4hep::Material::Material ( Object * e )

inline

Initialization from pointer.

Definition at line 281 of file Objects.h.

◆ Material() [4/5]

dd4hep::Material::Material ( const Handle< Object > & e )

inline

Constructorto be used for assignment from material handle.

Definition at line 284 of file Objects.h.

◆ Material() [5/5]

template<typename Q >

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

inline

Constructorto be used for assignment from object handle.

Definition at line 287 of file Objects.h.

Member Function Documentation

◆ A()

double Material::A ( ) const

atomic number of the underlying material

Definition at line 187 of file Objects.cpp.

◆ constProperty()

double Material::constProperty ( const std::string & name ) const

Access to tabular properties of the material.

Access to tabular properties of the optical surface.

Definition at line 276 of file Objects.cpp.

◆ constPropertyRef()

std::string Material::constPropertyRef	(	const std::string &	name,
		const std::string &	default_value = `""`
	)

Access string property value from the material table.

Definition at line 285 of file Objects.cpp.

◆ density()

double Material::density ( ) const

density of the underlying material

Definition at line 198 of file Objects.cpp.

◆ fraction()

double Material::fraction ( Atom atom ) const

Access the fraction of an element within the material.

Definition at line 231 of file Objects.cpp.

◆ intLength()

double Material::intLength ( ) const

Access the interaction length of the underlying material.

Access the radiation length of the underlying material.

Definition at line 220 of file Objects.cpp.

◆ operator=()

Material& dd4hep::Material::operator= ( const Material & copy )

default

Assignment operator.

◆ property() [1/2]

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

Access to tabular properties of the material.

Access to tabular properties of the optical surface.

Definition at line 258 of file Objects.cpp.

◆ property() [2/2]

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

Access to tabular properties of the material.

Access to tabular properties of the optical surface.

Definition at line 263 of file Objects.cpp.

◆ propertyRef()

std::string Material::propertyRef	(	const std::string &	name,
		const std::string &	default_value = `""`
	)

Access string property value from the material table.

Definition at line 268 of file Objects.cpp.

◆ radLength()

double Material::radLength ( ) const

Access the radiation length of the underlying material.

Definition at line 209 of file Objects.cpp.

◆ toString()

std::string Material::toString ( ) const

String representation of this object.

Definition at line 293 of file Objects.cpp.

◆ Z()

double Material::Z ( ) const

proton number of the underlying material

Definition at line 175 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 Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Property

Constructor & Destructor Documentation

◆ Material() [1/5]

◆ Material() [2/5]

◆ Material() [3/5]

◆ Material() [4/5]

◆ Material() [5/5]

Member Function Documentation

◆ A()

◆ constProperty()

◆ constPropertyRef()

◆ density()

◆ fraction()

◆ intLength()

◆ operator=()

◆ property() [1/2]

◆ property() [2/2]

◆ propertyRef()

◆ radLength()

◆ toString()

◆ Z()