Implementation of SimTrackerHit. More...

#include <SimTrackerHitImpl.h>

Inheritance diagram for IMPL::SimTrackerHitImpl:

Public Member Functions
	SimTrackerHitImpl ()
	Default constructor, initializes values to 0. More...

	SimTrackerHitImpl (const SimTrackerHitImpl &)=default
	default copy constructor - use with care More...

SimTrackerHitImpl &	operator= (const SimTrackerHitImpl &)=default
	default assignment operator - use with care More...

virtual	~SimTrackerHitImpl ()
	Destructor. More...

virtual int	id () const
	Returns an object id for internal (debugging) use in LCIO. More...

	LCIO_DEPRECATED ("Use getCellID0() instead", virtual int getCellID() const )
	DEPRECATED: use () More...

virtual int	getCellID0 () const
	Same name as in CalorimeterHit, even though there are no 'cells' in this case. More...

virtual int	getCellID1 () const
	Same name as in CalorimeterHit, even though there are no 'cells' in this case 0 if information is not stored - check the flag word (bit THBIT_ID1) of the collection. More...

virtual const double *	getPosition () const
	Returns the hit position. More...

	LCIO_DEPRECATED ("Use getEDep() instead", virtual float getdEdx() const )
	Returns the dE/dx of the hit. More...

virtual float	getEDep () const
	Returns the deposited energy of the hit [GeV]. More...

virtual float	getTime () const
	Returns the time of the hit. More...

virtual EVENT::MCParticle *	getMCParticle () const
	Returns the MC particle that caused the hit. More...

virtual const float *	getMomentum () const
	Returns the 3-momentum of the particle at the hits position in [GeV] - optional, only if bit LCIO::THBIT_MOMENTUM is set. More...

virtual float	getPathLength () const
	The path length of the particle in the sensitive material that resulted in this hit. More...

virtual int	getQuality () const
	The quality bit flag of the hit. More...

void	setCellID0 (int id0)
	Sets the first cell id;. More...

void	setCellID1 (int id1)
	Sets the second cell id; Only store if the flag word (bit THBIT_ID1) of the collection is set. More...

void	setPosition (const double pos[3])
	Sets the position. More...

	LCIO_DEPRECATED ("Use setEDep(float) instead", void setdEdx(float dEdX))
	Sets dE/dx. More...

void	setEDep (float e)
	Sets EDep. More...

void	setTime (float t)
	Sets the time. More...

void	setMCParticle (EVENT::MCParticle *particle)
	Sets the MCParticle that caused the hit. More...

void	setMomentum (const float p[3])
	Sets the momentum of the particle at the hit's position. More...

void	setMomentum (float px, float py, float pz)
	Sets the momentum of the particle at the hit's position. More...

void	setPathLength (float pathLength)

void	setQuality (int quality)

void	setQualityBit (int bit, bool val=true)

virtual bool	isOverlay () const
	True if the hit has been overlayed by the simulation (or digitization) program. More...

virtual bool	isProducedBySecondary () const
	True if the particle has been created by a secondary particle that is not stored in the MCParticle collection. More...

void	setOverlay (bool val)

void	setProducedBySecondary (bool val)

Public Member Functions inherited from EVENT::SimTrackerHit
virtual	~SimTrackerHit ()
	Destructor. More...

virtual int	getCellID () const =0
	DEPRECATED: use () More...

virtual float	getdEdx () const =0
	Returns the dE/dx of the hit in [GeV]. More...

Public Member Functions inherited from EVENT::LCObject
virtual	~LCObject ()
	Destructor. More...

virtual LCObject *	clone () const
	Returns an object id for internal (debugging) use in LCIO. More...

Public Member Functions inherited from lcrtrel::LCRTRelations
template<class V >
V::ext_type	ext ()
	Provides access to an extension object - the type and ownership is defined by the class V which should be a subtype of LCExtension, LCOwnedExtension, LCExtensionVector, LCExtensionList,... More...

template<class V >
const V::ext_type	ext () const
	Provides access to an extension object - the type and ownership is defined by the class V which should be a subtype of LCExtension, LCOwnedExtension, LCExtensionVector, LCExtensionList,... More...

template<class V >
V::rel_type	rel ()
	Provides read access to relations - the object types and their connectivity are defined by the class V which has to be a subtype of either LC1To1Relation, LC1ToNRelation or LCNToNRelation. More...

Public Member Functions inherited from IMPL::AccessChecked
	AccessChecked ()

virtual	~AccessChecked ()

virtual int	simpleUID () const

Protected Attributes
int	_cellID0

int	_cellID1

double	_pos [3]

float	_EDep

float	_time

EVENT::MCParticle *	_particle

float	_p [3]
	<– fixme: ROOT cannot handle this pointer !!???? More...

float	_pathLength

int	_quality

Protected Attributes inherited from IMPL::AccessChecked
bool	_readOnly {false}

int	_id {-1}

Additional Inherited Members
Public Types inherited from EVENT::SimTrackerHit
typedef SimTrackerHit	lcobject_type
	Useful typedef for template programming with LCIO. More...

Public Types inherited from lcrtrel::LCRTRelations
typedef std::type_index	ext_index

typedef std::shared_ptr< void >	ext_type

typedef std::map< ext_index, ext_type >	ext_map

Static Public Attributes inherited from EVENT::SimTrackerHit
static const int	BITOverlay = 31

static const int	BITProducedBySecondary = 30

Protected Member Functions inherited from IMPL::AccessChecked
virtual void	setReadOnly (bool readOnly)

void	checkAccess ()

void	checkAccess (const char *what)

Static Protected Attributes inherited from IMPL::AccessChecked
static std::atomic_int	_lCObjectId

Detailed Description

Implementation of SimTrackerHit.

See Also: SimTrackerHit

Author: gaede

Version: Mar 6, 2003

Definition at line 20 of file SimTrackerHitImpl.h.

Constructor & Destructor Documentation

IMPL::SimTrackerHitImpl::SimTrackerHitImpl ( )

Default constructor, initializes values to 0.

Definition at line 17 of file SimTrackerHitImpl.cc.

References _p, and _pos.

IMPL::SimTrackerHitImpl::SimTrackerHitImpl ( const SimTrackerHitImpl & )

default

default copy constructor - use with care

IMPL::SimTrackerHitImpl::~SimTrackerHitImpl ( )

virtual

Destructor.

Definition at line 36 of file SimTrackerHitImpl.cc.

Member Function Documentation

int IMPL::SimTrackerHitImpl::getCellID0 ( ) const

virtual

Same name as in CalorimeterHit, even though there are no 'cells' in this case.

Implements EVENT::SimTrackerHit.

Definition at line 43 of file SimTrackerHitImpl.cc.

References _cellID0.

int IMPL::SimTrackerHitImpl::getCellID1 ( ) const

virtual

Same name as in CalorimeterHit, even though there are no 'cells' in this case 0 if information is not stored - check the flag word (bit THBIT_ID1) of the collection.

Default is to store only cellid0.

Implements EVENT::SimTrackerHit.

Definition at line 44 of file SimTrackerHitImpl.cc.

References _cellID1.

float IMPL::SimTrackerHitImpl::getEDep ( ) const

virtual

Returns the deposited energy of the hit [GeV].

Implements EVENT::SimTrackerHit.

Definition at line 54 of file SimTrackerHitImpl.cc.

References _EDep.

EVENT::MCParticle * IMPL::SimTrackerHitImpl::getMCParticle ( ) const

virtual

Returns the MC particle that caused the hit.

See Also: MCParticle

Implements EVENT::SimTrackerHit.

Definition at line 58 of file SimTrackerHitImpl.cc.

References _particle.

const float * IMPL::SimTrackerHitImpl::getMomentum ( ) const

virtual

Returns the 3-momentum of the particle at the hits position in [GeV] - optional, only if bit LCIO::THBIT_MOMENTUM is set.

Implements EVENT::SimTrackerHit.

Definition at line 62 of file SimTrackerHitImpl.cc.

References _p.

float IMPL::SimTrackerHitImpl::getPathLength ( ) const

virtual

The path length of the particle in the sensitive material that resulted in this hit.

This is only stored together with momentum, i.e. if LCIO::THBIT_MOMENTUM is set.

Implements EVENT::SimTrackerHit.

Definition at line 60 of file SimTrackerHitImpl.cc.

References _pathLength.

const double * IMPL::SimTrackerHitImpl::getPosition ( ) const

virtual

Returns the hit position.

Implements EVENT::SimTrackerHit.

Definition at line 46 of file SimTrackerHitImpl.cc.

References _pos.

virtual int IMPL::SimTrackerHitImpl::getQuality ( ) const

inlinevirtual

The quality bit flag of the hit.

Implements EVENT::SimTrackerHit.

Definition at line 92 of file SimTrackerHitImpl.h.

References _quality.

float IMPL::SimTrackerHitImpl::getTime ( ) const

virtual

Returns the time of the hit.

TO DO needs definition.

Implements EVENT::SimTrackerHit.

Definition at line 56 of file SimTrackerHitImpl.cc.

References _time.

virtual int IMPL::SimTrackerHitImpl::id ( ) const

inlinevirtual

Returns an object id for internal (debugging) use in LCIO.

Implements EVENT::LCObject.

Definition at line 37 of file SimTrackerHitImpl.h.

References IMPL::AccessChecked::simpleUID().

bool IMPL::SimTrackerHitImpl::isOverlay ( ) const

virtual

True if the hit has been overlayed by the simulation (or digitization) program.

Implements EVENT::SimTrackerHit.

Definition at line 135 of file SimTrackerHitImpl.cc.

References _quality, and EVENT::SimTrackerHit::BITOverlay.

bool IMPL::SimTrackerHitImpl::isProducedBySecondary ( ) const

virtual

True if the particle has been created by a secondary particle that is not stored in the MCParticle collection.

Implements EVENT::SimTrackerHit.

Definition at line 136 of file SimTrackerHitImpl.cc.

References _quality, and EVENT::SimTrackerHit::BITProducedBySecondary.

IMPL::SimTrackerHitImpl::LCIO_DEPRECATED	(	"Use getCellID0() instead"	,
		virtual int getCellID()	const
	)

DEPRECATED: use ()

IMPL::SimTrackerHitImpl::LCIO_DEPRECATED	(	"Use getEDep() instead"	,
		virtual float getdEdx()	const
	)

Returns the dE/dx of the hit.

Deprecated:

See Also: getEDep()

IMPL::SimTrackerHitImpl::LCIO_DEPRECATED	(	"Use setEDep(float) instead"	,
		void	setdEdxfloat dEdX
	)

Sets dE/dx.

Deprecated:

See Also: setEDep()

SimTrackerHitImpl& IMPL::SimTrackerHitImpl::operator= ( const SimTrackerHitImpl & )

default

default assignment operator - use with care

void IMPL::SimTrackerHitImpl::setCellID0 ( int id0 )

Sets the first cell id;.

Definition at line 64 of file SimTrackerHitImpl.cc.

References _cellID0, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setCellID1 ( int id1 )

Sets the second cell id; Only store if the flag word (bit THBIT_ID1) of the collection is set.

Default is to store only cellid0.

Definition at line 69 of file SimTrackerHitImpl.cc.

References _cellID1, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setEDep ( float e )

Sets EDep.

Definition at line 88 of file SimTrackerHitImpl.cc.

References _EDep, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setMCParticle ( EVENT::MCParticle * particle )

Sets the MCParticle that caused the hit.

Definition at line 98 of file SimTrackerHitImpl.cc.

References _particle, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setMomentum ( const float p[3] )

Sets the momentum of the particle at the hit's position.

Definition at line 103 of file SimTrackerHitImpl.cc.

void IMPL::SimTrackerHitImpl::setMomentum	(	float	px,
		float	py,
		float	pz
	)

Sets the momentum of the particle at the hit's position.

Definition at line 108 of file SimTrackerHitImpl.cc.

References _p, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setOverlay ( bool val )

Definition at line 138 of file SimTrackerHitImpl.cc.

References EVENT::SimTrackerHit::BITOverlay, and setQualityBit().

void IMPL::SimTrackerHitImpl::setPathLength ( float pathLength )

Definition at line 117 of file SimTrackerHitImpl.cc.

References _pathLength, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setPosition ( const double pos[3] )

Sets the position.

Definition at line 74 of file SimTrackerHitImpl.cc.

References _pos, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setProducedBySecondary ( bool val )

Definition at line 139 of file SimTrackerHitImpl.cc.

References EVENT::SimTrackerHit::BITProducedBySecondary, and setQualityBit().

void IMPL::SimTrackerHitImpl::setQuality ( int quality )

Definition at line 122 of file SimTrackerHitImpl.cc.

References _quality, and IMPL::AccessChecked::checkAccess().

void IMPL::SimTrackerHitImpl::setQualityBit	(	int	bit,
		bool	val = `true`
	)

Definition at line 127 of file SimTrackerHitImpl.cc.

References _quality, and IMPL::AccessChecked::checkAccess().

Referenced by setOverlay(), and setProducedBySecondary().

void IMPL::SimTrackerHitImpl::setTime ( float t )

Sets the time.

Definition at line 93 of file SimTrackerHitImpl.cc.

References _time, and IMPL::AccessChecked::checkAccess().

Member Data Documentation

int IMPL::SimTrackerHitImpl::_cellID0

protected

Definition at line 162 of file SimTrackerHitImpl.h.

Referenced by getCellID0(), and setCellID0().

int IMPL::SimTrackerHitImpl::_cellID1

protected

Definition at line 163 of file SimTrackerHitImpl.h.

Referenced by getCellID1(), and setCellID1().

float IMPL::SimTrackerHitImpl::_EDep

protected

Definition at line 165 of file SimTrackerHitImpl.h.

Referenced by getEDep(), and setEDep().

float IMPL::SimTrackerHitImpl::_p[3]

protected

<– fixme: ROOT cannot handle this pointer !!????

Definition at line 168 of file SimTrackerHitImpl.h.

Referenced by getMomentum(), setMomentum(), and SimTrackerHitImpl().

EVENT::MCParticle* IMPL::SimTrackerHitImpl::_particle

protected

Definition at line 167 of file SimTrackerHitImpl.h.

Referenced by getMCParticle(), and setMCParticle().

float IMPL::SimTrackerHitImpl::_pathLength

protected

Definition at line 169 of file SimTrackerHitImpl.h.

Referenced by getPathLength(), and setPathLength().

double IMPL::SimTrackerHitImpl::_pos[3]

protected

Definition at line 164 of file SimTrackerHitImpl.h.

Referenced by getPosition(), setPosition(), and SimTrackerHitImpl().

int IMPL::SimTrackerHitImpl::_quality

protected

Definition at line 170 of file SimTrackerHitImpl.h.

Referenced by getQuality(), isOverlay(), isProducedBySecondary(), setQuality(), and setQualityBit().

float IMPL::SimTrackerHitImpl::_time

protected

Definition at line 166 of file SimTrackerHitImpl.h.

Referenced by getTime(), and setTime().

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

/afs/desy.de/user/d/dudarboh/iLCSoft/LCIO/src/cpp/include/IMPL/SimTrackerHitImpl.h
/afs/desy.de/user/d/dudarboh/iLCSoft/LCIO/src/cpp/src/IMPL/SimTrackerHitImpl.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation