edm4eic::RawHGCROCHit Class Reference

#include <RawHGCROCHit.h>

Public Types
using	mutable_type = MutableRawHGCROCHit
using	collection_type = RawHGCROCHitCollection

Public Member Functions
	RawHGCROCHit ()
	default constructor
	RawHGCROCHit (const std::uint64_t cellID, const std::int32_t samplePhase, const std::int32_t timeStamp)
	Constructor initializing all members.
	RawHGCROCHit (const RawHGCROCHit &other)=default
	copy constructor
RawHGCROCHit &	operator= (RawHGCROCHit other) &
	copy-assignment operator
RawHGCROCHit &	operator= (RawHGCROCHit other) &&=delete
MutableRawHGCROCHit	clone (bool cloneRelations=true) const
	~RawHGCROCHit ()=default
	destructor
	RawHGCROCHit (const MutableRawHGCROCHit &other)
	converting constructor from mutable object
std::uint64_t	getCellID () const
	Access the Detector specific (geometrical) cell id.
std::int32_t	getSamplePhase () const
	Access the Phase of samples in [# samples], for synchronizing across chips.
std::int32_t	getTimeStamp () const
	Access the [TDC counts].
std::size_t	samples_size () const
edm4eic::HGCROCSample	getSamples (std::size_t) const
std::vector< edm4eic::HGCROCSample >::const_iterator	samples_begin () const
std::vector< edm4eic::HGCROCSample >::const_iterator	samples_end () const
podio::RelationRange< edm4eic::HGCROCSample >	getSamples () const
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from RawHGCROCHitObj instance
bool	operator== (const RawHGCROCHit &other) const
bool	operator== (const MutableRawHGCROCHit &other) const
bool	operator!= (const RawHGCROCHit &other) const
bool	operator!= (const MutableRawHGCROCHit &other) const
bool	operator< (const RawHGCROCHit &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static RawHGCROCHit	makeEmpty ()

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::RawHGCROCHit"

Friends
class	MutableRawHGCROCHit
class	RawHGCROCHitCollection
class	edm4eic::RawHGCROCHitCollectionData
class	RawHGCROCHitCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const RawHGCROCHit &obj)
void	swap (RawHGCROCHit &a, RawHGCROCHit &b)

Detailed Description

Raw hit from an HGCROC chip

Author

: D. Anderson, S. Joosten, T. Protzman, N. Novitzky, D. Kalinkin

Member Typedef Documentation

collection_type

using edm4eic::RawHGCROCHit::collection_type = RawHGCROCHitCollection

mutable_type

using edm4eic::RawHGCROCHit::mutable_type = MutableRawHGCROCHit

Constructor & Destructor Documentation

RawHGCROCHit() [1/4]

edm4eic::RawHGCROCHit::RawHGCROCHit

(

)

default constructor

RawHGCROCHit() [2/4]

edm4eic::RawHGCROCHit::RawHGCROCHit	(	const std::uint64_t	cellID,
		const std::int32_t	samplePhase,
		const std::int32_t	timeStamp )

Constructor initializing all members.

RawHGCROCHit() [3/4]

edm4eic::RawHGCROCHit::RawHGCROCHit ( const RawHGCROCHit & other )

default

copy constructor

~RawHGCROCHit()

edm4eic::RawHGCROCHit::~RawHGCROCHit ( )

default

destructor

RawHGCROCHit() [4/4]

edm4eic::RawHGCROCHit::RawHGCROCHit

(

const MutableRawHGCROCHit &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableRawHGCROCHit edm4eic::RawHGCROCHit::clone

(

bool

cloneRelations = true

)

const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

getCellID()

std::uint64_t edm4eic::RawHGCROCHit::getCellID

(

)

const

Access the Detector specific (geometrical) cell id.

getObjectID()

const podio::ObjectID edm4eic::RawHGCROCHit::getObjectID

(

)

const

getSamplePhase()

std::int32_t edm4eic::RawHGCROCHit::getSamplePhase

(

)

const

Access the Phase of samples in [# samples], for synchronizing across chips.

getSamples() [1/2]

podio::RelationRange< edm4eic::HGCROCSample > edm4eic::RawHGCROCHit::getSamples

(

)

const

getSamples() [2/2]

edm4eic::HGCROCSample edm4eic::RawHGCROCHit::getSamples

(

std::size_t

index

)

const

getTimeStamp()

std::int32_t edm4eic::RawHGCROCHit::getTimeStamp

(

)

const

Access the [TDC counts].

id()

podio::ObjectID edm4eic::RawHGCROCHit::id ( ) const

inline

isAvailable()

bool edm4eic::RawHGCROCHit::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

RawHGCROCHit edm4eic::RawHGCROCHit::makeEmpty ( )

static

operator!=() [1/2]

bool edm4eic::RawHGCROCHit::operator!= ( const MutableRawHGCROCHit & other ) const

inline

operator!=() [2/2]

bool edm4eic::RawHGCROCHit::operator!= ( const RawHGCROCHit & other ) const

inline

operator<()

bool edm4eic::RawHGCROCHit::operator< ( const RawHGCROCHit & other ) const

inline

operator=() [1/2]

RawHGCROCHit & edm4eic::RawHGCROCHit::operator=

(

RawHGCROCHit

other

)

&

copy-assignment operator

operator=() [2/2]

RawHGCROCHit & edm4eic::RawHGCROCHit::operator= ( RawHGCROCHit other ) &&

delete

operator==() [1/2]

bool edm4eic::RawHGCROCHit::operator==

(

const MutableRawHGCROCHit &

other

)

const

operator==() [2/2]

bool edm4eic::RawHGCROCHit::operator== ( const RawHGCROCHit & other ) const

inline

samples_begin()

std::vector< edm4eic::HGCROCSample >::const_iterator edm4eic::RawHGCROCHit::samples_begin

(

)

const

samples_end()

std::vector< edm4eic::HGCROCSample >::const_iterator edm4eic::RawHGCROCHit::samples_end

(

)

const

samples_size()

std::size_t edm4eic::RawHGCROCHit::samples_size

(

)

const

unlink()

void edm4eic::RawHGCROCHit::unlink ( )

inline

disconnect from RawHGCROCHitObj instance

Friends And Related Symbol Documentation

edm4eic::RawHGCROCHitCollectionData

friend class edm4eic::RawHGCROCHitCollectionData

friend

MutableRawHGCROCHit

friend class MutableRawHGCROCHit

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const RawHGCROCHit & obj )

friend

RawHGCROCHitCollection

friend class RawHGCROCHitCollection

friend

RawHGCROCHitCollectionIterator

friend class RawHGCROCHitCollectionIterator

friend

swap

void swap ( RawHGCROCHit & a, RawHGCROCHit & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::RawHGCROCHit::typeName = "edm4eic::RawHGCROCHit"

staticconstexpr

---

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

• build/edm4eic/RawHGCROCHit.h
• build/src/RawHGCROCHit.cc