EDM4eic
EIC data model
Loading...
Searching...
No Matches
edm4eic::MutablePMTHit Class Reference

#include <MutablePMTHit.h>

Public Types

using object_type = PMTHit
 
using collection_type = PMTHitCollection
 

Public Member Functions

 MutablePMTHit ()
 default constructor
 
 MutablePMTHit (std::uint64_t cellID, float npe, float time, float timeError, edm4hep::Vector3f position, edm4hep::Vector3f dimension, std::int32_t sector, edm4hep::Vector3f local)
 Constructor initializing all members.
 
 MutablePMTHit (const MutablePMTHit &other)=default
 copy constructor
 
MutablePMTHitoperator= (MutablePMTHit other)
 copy-assignment operator
 
MutablePMTHit clone () const
 create a mutable deep-copy of the object with identical relations
 
 ~MutablePMTHit ()=default
 destructor
 
 operator PMTHit () const
 conversion to const object
 
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 (std::uint64_t value)
 Set the The detector specific (geometrical) cell id.
 
void setNpe (float value)
 Set the Estimated number of photo-electrons [#].
 
void setTime (float value)
 Set the Time [ns].
 
void setTimeError (float value)
 Set the Error on the time [ns].
 
void setPosition (edm4hep::Vector3f value)
 Set the PMT hit position [mm].
 
edm4hep::Vector3f & position ()
 Get reference to PMT hit position [mm].
 
void setDimension (edm4hep::Vector3f value)
 Set the The dimension information of the pixel [mm].
 
edm4hep::Vector3f & dimension ()
 Get reference to The dimension information of the pixel [mm].
 
void setSector (std::int32_t value)
 Set the The sector this hit occurred in.
 
void setLocal (edm4hep::Vector3f value)
 Set the 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
 
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

◆ object_type

Constructor & Destructor Documentation

◆ MutablePMTHit() [1/3]

edm4eic::MutablePMTHit::MutablePMTHit ( )

default constructor

◆ MutablePMTHit() [2/3]

edm4eic::MutablePMTHit::MutablePMTHit ( std::uint64_t cellID,
float npe,
float time,
float timeError,
edm4hep::Vector3f position,
edm4hep::Vector3f dimension,
std::int32_t sector,
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

◆ clone()

MutablePMTHit edm4eic::MutablePMTHit::clone ( ) const

create a mutable deep-copy of the object with identical relations

◆ dimension()

edm4hep::Vector3f & edm4eic::MutablePMTHit::dimension ( )

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

◆ getCellID()

std::uint64_t edm4eic::MutablePMTHit::getCellID ( ) const

Access the The detector specific (geometrical) cell id.

◆ getDimension()

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

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

◆ getLocal()

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

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

◆ getNpe()

float edm4eic::MutablePMTHit::getNpe ( ) const

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

◆ getObjectID()

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

◆ getPosition()

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

Access the PMT hit position [mm].

◆ getSector()

std::int32_t edm4eic::MutablePMTHit::getSector ( ) const

Access the The sector this hit occurred in.

◆ getTime()

float edm4eic::MutablePMTHit::getTime ( ) const

Access the Time [ns].

◆ getTimeError()

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].

◆ operator PMTHit()

edm4eic::MutablePMTHit::operator PMTHit ( ) const

conversion to const object

◆ operator<()

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

◆ operator=()

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

copy-assignment operator

◆ 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].

◆ setCellID()

void edm4eic::MutablePMTHit::setCellID ( std::uint64_t value)

Set the The detector specific (geometrical) cell id.

◆ setDimension()

void edm4eic::MutablePMTHit::setDimension ( edm4hep::Vector3f value)

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

◆ setLocal()

void edm4eic::MutablePMTHit::setLocal ( edm4hep::Vector3f value)

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

◆ setNpe()

void edm4eic::MutablePMTHit::setNpe ( float value)

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

◆ setPosition()

void edm4eic::MutablePMTHit::setPosition ( edm4hep::Vector3f value)

Set the PMT hit position [mm].

◆ setSector()

void edm4eic::MutablePMTHit::setSector ( std::int32_t value)

Set the The sector this hit occurred in.

◆ setTime()

void edm4eic::MutablePMTHit::setTime ( float value)

Set the Time [ns].

◆ setTimeError()

void edm4eic::MutablePMTHit::setTimeError ( float value)

Set the 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: