TimedHitPtr Class Reference

a smart pointer to a hit that also provides access to the extended timing info of the host event. For a pu event this is taken from the event PileUpTimeEventIndex usually accessed via PileUpMergeSvc::TimedList More...

#include <SCT_SurfaceChargesGenerator.h>

Collaboration diagram for TimedHitPtr:

Public Types
using	element_type = std::add_const_t< HIT >
using	value_type = HIT
using	const_value_type = element_type

Public Member Functions
	TimedHitPtr ()=default
	STL required constructors. More...
	TimedHitPtr (const TimedHitPtr< HIT > &rhs)=default
	TimedHitPtr (TimedHitPtr< HIT > &&rhs)=default
	TimedHitPtr (float eventTime, const HIT *pHit, int pileupType=0)
	minimal constructor: pass only t0 offset of bunch xing More...
	TimedHitPtr (float eventTime, unsigned short eventId, const HIT *pHit, int pileupType=0)
	use this constructor when hit has a PileUpTimeEventIndex More...
TimedHitPtr< HIT > &	operator= (const TimedHitPtr< HIT > &rhs)=default
	assignment operator More...
TimedHitPtr< HIT > &	operator= (TimedHitPtr< HIT > &&rhs)=default
const HIT &	operator* () const
	smart pointer interface More...
const HIT *	operator-> () const
const HIT *	get () const
	operator bool () const
unsigned short	eventId () const
	the index of the component event in PileUpEventInfo. More...
int	pileupType () const
	the type of event which the hit came from (signal, low pt minbias, high pt minbias, cavern bg, etc.) More...
float	eventTime () const
	t0 offset of the bunch xing containing the hit in ns. More...

Private Attributes
float	m_eventTime {0.f}
	t0 offset of the bunch xing in ns More...
unsigned short	m_eventId {0u}
	the index in PileUpEventInfo of the component event hosting this hit More...
int	m_pileupType {0}
const HIT *	m_pHit {nullptr}

Friends
template<class FHIT >
float	hitTime (const TimedHitPtr< FHIT > &)

Detailed Description

a smart pointer to a hit that also provides access to the extended timing info of the host event. For a pu event this is taken from the event PileUpTimeEventIndex usually accessed via PileUpMergeSvc::TimedList

Definition at line 77 of file SCT_SurfaceChargesGenerator.h.

Member Typedef Documentation

const_value_type

using TimedHitPtr::const_value_type = element_type

Definition at line 22 of file TimedHitPtr.h.

element_type

using TimedHitPtr::element_type = std::add_const_t<HIT>

Definition at line 20 of file TimedHitPtr.h.

value_type

using TimedHitPtr::value_type = HIT

Definition at line 21 of file TimedHitPtr.h.

Constructor & Destructor Documentation

TimedHitPtr() [1/5]

TimedHitPtr::TimedHitPtr ( )

default

STL required constructors.

TimedHitPtr() [2/5]

TimedHitPtr::TimedHitPtr ( const TimedHitPtr< HIT > &  rhs )

default

TimedHitPtr() [3/5]

TimedHitPtr::TimedHitPtr ( TimedHitPtr< HIT > &&  rhs )

default

TimedHitPtr() [4/5]

TimedHitPtr::TimedHitPtr ( float  eventTime, const HIT *  pHit, int  pileupType = 0  )

inline

minimal constructor: pass only t0 offset of bunch xing

Definition at line 30 of file TimedHitPtr.h.

                                                                  :
    m_eventTime(eventTime), m_eventId(0), m_pileupType(pileupType), m_pHit(pHit) {}

TimedHitPtr() [5/5]

TimedHitPtr::TimedHitPtr ( float  eventTime, unsigned short  eventId, const HIT *  pHit, int  pileupType = 0  )

inline

use this constructor when hit has a PileUpTimeEventIndex

Definition at line 33 of file TimedHitPtr.h.

                                                                                          :
    m_eventTime(eventTime), m_eventId(eventId), m_pileupType(pileupType), m_pHit(pHit) {}

Member Function Documentation

eventId()

unsigned short TimedHitPtr::eventId ( ) const

inline

the index of the component event in PileUpEventInfo.

Allows, in principle, to navigate back to the parent event

Definition at line 47 of file TimedHitPtr.h.

{ return m_eventId; }

eventTime()

float TimedHitPtr::eventTime ( ) const

inline

t0 offset of the bunch xing containing the hit in ns.

This is an integer multiple of the bunch xing distance for a certain event (e.g. N*25ns)

Definition at line 55 of file TimedHitPtr.h.

{ return m_eventTime; }

get()

const HIT* TimedHitPtr::get ( ) const

inline

Definition at line 42 of file TimedHitPtr.h.

{ return m_pHit; }

operator bool()

TimedHitPtr::operator bool ( ) const

inline

Definition at line 44 of file TimedHitPtr.h.

{ return m_pHit != nullptr; }

operator*()

const HIT& TimedHitPtr::operator* ( ) const

inline

smart pointer interface

Definition at line 40 of file TimedHitPtr.h.

{ return *m_pHit; }

operator->()

const HIT* TimedHitPtr::operator-> ( ) const

inline

Definition at line 41 of file TimedHitPtr.h.

{ return m_pHit; }

operator=() [1/2]

TimedHitPtr<HIT>& TimedHitPtr::operator= ( const TimedHitPtr< HIT > &  rhs )

default

assignment operator

operator=() [2/2]

TimedHitPtr<HIT>& TimedHitPtr::operator= ( TimedHitPtr< HIT > &&  rhs )

default

pileupType()

int TimedHitPtr::pileupType ( ) const

inline

the type of event which the hit came from (signal, low pt minbias, high pt minbias, cavern bg, etc.)

Definition at line 51 of file TimedHitPtr.h.

{ return m_pileupType; }

Friends And Related Function Documentation

hitTime

template<class FHIT >

float hitTime ( const TimedHitPtr< FHIT > &  )

friend

Member Data Documentation

m_eventId

unsigned short TimedHitPtr::m_eventId {0u}

private

the index in PileUpEventInfo of the component event hosting this hit

Definition at line 62 of file TimedHitPtr.h.

m_eventTime

float TimedHitPtr::m_eventTime {0.f}

private

t0 offset of the bunch xing in ns

Definition at line 60 of file TimedHitPtr.h.

m_pHit

const HIT* TimedHitPtr::m_pHit {nullptr}

private

Definition at line 64 of file TimedHitPtr.h.

m_pileupType

int TimedHitPtr::m_pileupType {0}

private

Definition at line 63 of file TimedHitPtr.h.

---

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

• SCT_SurfaceChargesGenerator.h
• TimedHitPtr.h