Handle to the implementation of the readout structure of a subdetector. More...

#include <Readout.h>

Inheritance diagram for dd4hep::Readout:

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

	Readout (Readout &&e)=default
	Copy Constructor from object. More...

	Readout (const Readout &e)=default
	Copy Constructor from object. More...

	Readout (Handle< ReadoutObject > &&e)
	Move constructor from handle. More...

	Readout (const Handle< ReadoutObject > &e)
	Copy Constructor from handle. More...

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

	Readout (const std::string &name)
	Initializing constructor. More...

Readout &	operator= (Readout &&ro)=default
	Assignment move operator. More...

Readout &	operator= (const Readout &ro)=default
	Assignment operator. More...

std::vector< std::string >	collectionNames () const
	Access explicit names of hit collections if present. More...

std::vector< const HitCollection * >	collections () const
	Access hit collections if present. More...

size_t	numCollections () const
	Access number of hit collections. More...

void	setIDDescriptor (const Ref_t &spec) const
	Assign IDDescription to readout structure. More...

IDDescriptor	idSpec () const
	Access IDDescription structure. More...

void	setSegmentation (const Segmentation &segment) const
	Assign segmentation structure to readout. More...

Segmentation	segmentation () const
	Access segmentation structure. More...

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

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

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

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

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

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

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

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

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

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

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

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

ReadoutObject *	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< ReadoutObject >
typedef ReadoutObject	Object
	Extern accessible definition of the contained element type. More...

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

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

Detailed Description

Handle to the implementation of the readout structure of a subdetector.

If there is no explicit hit collection defined, by default one single hit collection is defined by the name of the readout itself. If hit collections are defined, ALL must be defined.

Author: M.Frank

Version: 1.0

Definition at line 38 of file Readout.h.

Constructor & Destructor Documentation

◆ Readout() [1/7]

dd4hep::Readout::Readout ( )

default

Default constructor.

◆ Readout() [2/7]

dd4hep::Readout::Readout ( Readout && e )

default

Copy Constructor from object.

◆ Readout() [3/7]

dd4hep::Readout::Readout ( const Readout & e )

default

Copy Constructor from object.

◆ Readout() [4/7]

dd4hep::Readout::Readout ( Handle< ReadoutObject > && e )

inline

Move constructor from handle.

Definition at line 51 of file Readout.h.

◆ Readout() [5/7]

dd4hep::Readout::Readout ( const Handle< ReadoutObject > & e )

inline

Copy Constructor from handle.

Definition at line 53 of file Readout.h.

◆ Readout() [6/7]

template<typename Q >

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

inline

Constructor to be used when reading the already parsed object.

Definition at line 57 of file Readout.h.

◆ Readout() [7/7]

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

Initializing constructor.

Initializing constructor to create a new object.

Definition at line 50 of file Readout.cpp.

Member Function Documentation

◆ collectionNames()

std::vector< std::string > Readout::collectionNames ( ) const

Access explicit names of hit collections if present.

Access names of hit collections.

Definition at line 65 of file Readout.cpp.

◆ collections()

std::vector< const HitCollection * > Readout::collections ( ) const

Access hit collections if present.

Access hit collectionsy.

Definition at line 80 of file Readout.cpp.

◆ idSpec()

IDDescriptor Readout::idSpec ( ) const

Access IDDescription structure.

Definition at line 112 of file Readout.cpp.

◆ numCollections()

size_t Readout::numCollections ( ) const

Access number of hit collections.

Definition at line 55 of file Readout.cpp.

◆ operator=() [1/2]

Readout& dd4hep::Readout::operator= ( const Readout & ro )

default

Assignment operator.

◆ operator=() [2/2]

Readout& dd4hep::Readout::operator= ( Readout && ro )

default

Assignment move operator.

◆ segmentation()

Segmentation Readout::segmentation ( ) const

Access segmentation structure.

Definition at line 134 of file Readout.cpp.

◆ setIDDescriptor()

void Readout::setIDDescriptor ( const Ref_t & spec ) const

Assign IDDescription to readout structure.

Definition at line 95 of file Readout.cpp.

◆ setSegmentation()

void Readout::setSegmentation ( const Segmentation & segment ) const

Assign segmentation structure to readout.

Definition at line 117 of file Readout.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Readout() [1/7]

◆ Readout() [2/7]

◆ Readout() [3/7]

◆ Readout() [4/7]

◆ Readout() [5/7]

◆ Readout() [6/7]

◆ Readout() [7/7]

Member Function Documentation

◆ collectionNames()

◆ collections()

◆ idSpec()

◆ numCollections()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ segmentation()

◆ setIDDescriptor()

◆ setSegmentation()