edm4eic::MutablePMTHit Class Reference

#include <MutablePMTHit.h>

Public Types
using	object_type = PMTHit
using	collection_type = PMTHitCollection

Public Member Functions
	MutablePMTHit ()
	default constructor
	MutablePMTHit (const std::uint64_t cellID, const float npe, const float time, const float timeError, const edm4hep::Vector3f &position, const edm4hep::Vector3f &dimension, const std::int32_t sector, const edm4hep::Vector3f &local)
	Constructor initializing all members.
	MutablePMTHit (const MutablePMTHit &other)=default
	copy constructor
MutablePMTHit &	operator= (MutablePMTHit other) &
	copy-assignment operator
MutablePMTHit &	operator= (MutablePMTHit other) &&=delete
MutablePMTHit	clone (bool cloneRelations=true) const
	~MutablePMTHit ()=default
	destructor
std::uint64_t	getCellID () const
	Access the The detector specific (geometrical) cell id.
float	getNpe () const
	Access the Estimated number of photo-electrons [#].
float	getTime () const
	Access the Time [ns].
float	getTimeError () const
	Access the Error on the time [ns].
const edm4hep::Vector3f &	getPosition () const
	Access the PMT hit position [mm].
const edm4hep::Vector3f &	getDimension () const
	Access the The dimension information of the pixel [mm].
std::int32_t	getSector () const
	Access the The sector this hit occurred in.
const edm4hep::Vector3f &	getLocal () const
	Access the The local position of the hit in detector coordinates (relative to the sector) [mm].
void	setCellID (const std::uint64_t cellID)
	Set the The detector specific (geometrical) cell id.
std::uint64_t &	getCellID ()
	Get mutable reference to The detector specific (geometrical) cell id.
std::uint64_t &	cellID ()
	Get reference to The detector specific (geometrical) cell id.
void	setNpe (const float npe)
	Set the Estimated number of photo-electrons [#].
float &	getNpe ()
	Get mutable reference to Estimated number of photo-electrons [#].
float &	npe ()
	Get reference to Estimated number of photo-electrons [#].
void	setTime (const float time)
	Set the Time [ns].
float &	getTime ()
	Get mutable reference to Time [ns].
float &	time ()
	Get reference to Time [ns].
void	setTimeError (const float timeError)
	Set the Error on the time [ns].
float &	getTimeError ()
	Get mutable reference to Error on the time [ns].
float &	timeError ()
	Get reference to Error on the time [ns].
void	setPosition (const edm4hep::Vector3f &position)
	Set the PMT hit position [mm].
edm4hep::Vector3f &	getPosition ()
	Get mutable reference to PMT hit position [mm].
edm4hep::Vector3f &	position ()
	Get reference to PMT hit position [mm].
void	setDimension (const edm4hep::Vector3f &dimension)
	Set the The dimension information of the pixel [mm].
edm4hep::Vector3f &	getDimension ()
	Get mutable reference to The dimension information of the pixel [mm].
edm4hep::Vector3f &	dimension ()
	Get reference to The dimension information of the pixel [mm].
void	setSector (const std::int32_t sector)
	Set the The sector this hit occurred in.
std::int32_t &	getSector ()
	Get mutable reference to The sector this hit occurred in.
std::int32_t &	sector ()
	Get reference to The sector this hit occurred in.
void	setLocal (const edm4hep::Vector3f &local)
	Set the The local position of the hit in detector coordinates (relative to the sector) [mm].
edm4hep::Vector3f &	getLocal ()
	Get mutable reference to The local position of the hit in detector coordinates (relative to the sector) [mm].
edm4hep::Vector3f &	local ()
	Get reference to The local position of the hit in detector coordinates (relative to the sector) [mm].
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from PMTHitObj instance
bool	operator== (const MutablePMTHit &other) const
bool	operator== (const PMTHit &other) const
bool	operator!= (const MutablePMTHit &other) const
bool	operator!= (const PMTHit &other) const
bool	operator< (const MutablePMTHit &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Friends
class	PMTHitCollection
class	PMTHitMutableCollectionIterator
class	PMTHit
void	swap (MutablePMTHit &a, MutablePMTHit &b)

Detailed Description

EIC PMT hit

Author

: S. Joosten, C. Peng

Member Typedef Documentation

collection_type

using edm4eic::MutablePMTHit::collection_type = PMTHitCollection

object_type

using edm4eic::MutablePMTHit::object_type = PMTHit

Constructor & Destructor Documentation

MutablePMTHit() [1/3]

edm4eic::MutablePMTHit::MutablePMTHit

(

)

default constructor

MutablePMTHit() [2/3]

edm4eic::MutablePMTHit::MutablePMTHit	(	const std::uint64_t	cellID,
		const float	npe,
		const float	time,
		const float	timeError,
		const edm4hep::Vector3f &	position,
		const edm4hep::Vector3f &	dimension,
		const std::int32_t	sector,
		const edm4hep::Vector3f &	local )

Constructor initializing all members.

MutablePMTHit() [3/3]

edm4eic::MutablePMTHit::MutablePMTHit ( const MutablePMTHit & other )

default

copy constructor

~MutablePMTHit()

edm4eic::MutablePMTHit::~MutablePMTHit ( )

default

destructor

Member Function Documentation

cellID()

std::uint64_t & edm4eic::MutablePMTHit::cellID

(

)

Get reference to The detector specific (geometrical) cell id.

clone()

MutablePMTHit edm4eic::MutablePMTHit::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

dimension()

edm4hep::Vector3f & edm4eic::MutablePMTHit::dimension

(

)

Get reference to The dimension information of the pixel [mm].

getCellID() [1/2]

std::uint64_t & edm4eic::MutablePMTHit::getCellID

(

)

Get mutable reference to The detector specific (geometrical) cell id.

getCellID() [2/2]

std::uint64_t edm4eic::MutablePMTHit::getCellID

(

)

const

Access the The detector specific (geometrical) cell id.

getDimension() [1/2]

edm4hep::Vector3f & edm4eic::MutablePMTHit::getDimension

(

)

Get mutable reference to The dimension information of the pixel [mm].

getDimension() [2/2]

const edm4hep::Vector3f & edm4eic::MutablePMTHit::getDimension

(

)

const

Access the The dimension information of the pixel [mm].

getLocal() [1/2]

edm4hep::Vector3f & edm4eic::MutablePMTHit::getLocal

(

)

Get mutable reference to The local position of the hit in detector coordinates (relative to the sector) [mm].

getLocal() [2/2]

const edm4hep::Vector3f & edm4eic::MutablePMTHit::getLocal

(

)

const

Access the The local position of the hit in detector coordinates (relative to the sector) [mm].

getNpe() [1/2]

float & edm4eic::MutablePMTHit::getNpe

(

)

Get mutable reference to Estimated number of photo-electrons [#].

getNpe() [2/2]

float edm4eic::MutablePMTHit::getNpe

(

)

const

Access the Estimated number of photo-electrons [#].

getObjectID()

const podio::ObjectID edm4eic::MutablePMTHit::getObjectID

(

)

const

getPosition() [1/2]

edm4hep::Vector3f & edm4eic::MutablePMTHit::getPosition

(

)

Get mutable reference to PMT hit position [mm].

getPosition() [2/2]

const edm4hep::Vector3f & edm4eic::MutablePMTHit::getPosition

(

)

const

Access the PMT hit position [mm].

getSector() [1/2]

std::int32_t & edm4eic::MutablePMTHit::getSector

(

)

Get mutable reference to The sector this hit occurred in.

getSector() [2/2]

std::int32_t edm4eic::MutablePMTHit::getSector

(

)

const

Access the The sector this hit occurred in.

getTime() [1/2]

float & edm4eic::MutablePMTHit::getTime

(

)

Get mutable reference to Time [ns].

getTime() [2/2]

float edm4eic::MutablePMTHit::getTime

(

)

const

Access the Time [ns].

getTimeError() [1/2]

float & edm4eic::MutablePMTHit::getTimeError

(

)

Get mutable reference to Error on the time [ns].

getTimeError() [2/2]

float edm4eic::MutablePMTHit::getTimeError

(

)

const

Access the Error on the time [ns].

id()

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

inline

isAvailable()

bool edm4eic::MutablePMTHit::isAvailable

(

)

const

check whether the object is actually available

local()

edm4hep::Vector3f & edm4eic::MutablePMTHit::local

(

)

Get reference to The local position of the hit in detector coordinates (relative to the sector) [mm].

npe()

float & edm4eic::MutablePMTHit::npe

(

)

Get reference to Estimated number of photo-electrons [#].

operator!=() [1/2]

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

inline

operator!=() [2/2]

bool edm4eic::MutablePMTHit::operator!= ( const PMTHit & other ) const

inline

operator<()

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

inline

operator=() [1/2]

MutablePMTHit & edm4eic::MutablePMTHit::operator=

(

MutablePMTHit

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MutablePMTHit::operator==

(

const PMTHit &

other

)

const

position()

edm4hep::Vector3f & edm4eic::MutablePMTHit::position

(

)

Get reference to PMT hit position [mm].

sector()

std::int32_t & edm4eic::MutablePMTHit::sector

(

)

Get reference to The sector this hit occurred in.

setCellID()

void edm4eic::MutablePMTHit::setCellID

(

const std::uint64_t

cellID

)

Set the The detector specific (geometrical) cell id.

setDimension()

void edm4eic::MutablePMTHit::setDimension

(

const edm4hep::Vector3f &

dimension

)

Set the The dimension information of the pixel [mm].

setLocal()

void edm4eic::MutablePMTHit::setLocal

(

const edm4hep::Vector3f &

local

)

Set the The local position of the hit in detector coordinates (relative to the sector) [mm].

setNpe()

void edm4eic::MutablePMTHit::setNpe

(

const float

npe

)

Set the Estimated number of photo-electrons [#].

setPosition()

void edm4eic::MutablePMTHit::setPosition

(

const edm4hep::Vector3f &

position

)

Set the PMT hit position [mm].

setSector()

void edm4eic::MutablePMTHit::setSector

(

const std::int32_t

sector

)

Set the The sector this hit occurred in.

setTime()

void edm4eic::MutablePMTHit::setTime

(

const float

time

)

Set the Time [ns].

setTimeError()

void edm4eic::MutablePMTHit::setTimeError

(

const float

timeError

)

Set the Error on the time [ns].

time()

float & edm4eic::MutablePMTHit::time

(

)

Get reference to Time [ns].

timeError()

float & edm4eic::MutablePMTHit::timeError

(

)

Get reference to Error on the time [ns].

unlink()

void edm4eic::MutablePMTHit::unlink ( )

inline

disconnect from PMTHitObj instance

Friends And Related Symbol Documentation

PMTHit

friend class PMTHit

friend

PMTHitCollection

friend class PMTHitCollection

friend

PMTHitMutableCollectionIterator

friend class PMTHitMutableCollectionIterator

friend

swap

void swap ( MutablePMTHit & a, MutablePMTHit & b )

friend

---

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

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