EICd
EIC data model
eicd::MutableCalorimeterHit Class Reference

#include <MutableCalorimeterHit.h>

Public Member Functions

 MutableCalorimeterHit ()
 default constructor More...
 
 MutableCalorimeterHit (std::uint64_t cellID, float energy, float energyError, float time, float timeError, edm4hep::Vector3f position, edm4hep::Vector3f dimension, std::int32_t sector, std::int32_t layer, edm4hep::Vector3f local)
 
 MutableCalorimeterHit (CalorimeterHitObj *obj)
 constructor from existing CalorimeterHitObj More...
 
 MutableCalorimeterHit (const MutableCalorimeterHit &other)
 copy constructor More...
 
MutableCalorimeterHitoperator= (MutableCalorimeterHit other)
 copy-assignment operator More...
 
MutableCalorimeterHit clone () const
 create a mutable deep-copy of the object with identical relations More...
 
 ~MutableCalorimeterHit ()
 destructor More...
 
 operator CalorimeterHit () const
 conversion to const object More...
 
const std::uint64_t & getCellID () const
 Access the The detector specific (geometrical) cell id. More...
 
const float & getEnergy () const
 Access the The energy for this hit in [GeV]. More...
 
const float & getEnergyError () const
 Access the Error on energy [GeV]. More...
 
const float & getTime () const
 Access the The time of the hit in [ns]. More...
 
const float & getTimeError () const
 Access the Error on the time. More...
 
const edm4hep::Vector3f & getPosition () const
 Access the The global position of the hit in world coordinates [mm]. More...
 
const edm4hep::Vector3f & getDimension () const
 Access the The dimension information of the cell [mm]. More...
 
const std::int32_t & getSector () const
 Access the Sector that this hit occured in. More...
 
const std::int32_t & getLayer () const
 Access the Layer that the hit occured in. More...
 
const edm4hep::Vector3f & getLocal () const
 Access the The local coordinates of the hit in the detector segment [mm]. More...
 
void setCellID (std::uint64_t value)
 Set the The detector specific (geometrical) cell id. More...
 
void setEnergy (float value)
 Set the The energy for this hit in [GeV]. More...
 
void setEnergyError (float value)
 Set the Error on energy [GeV]. More...
 
void setTime (float value)
 Set the The time of the hit in [ns]. More...
 
void setTimeError (float value)
 Set the Error on the time. More...
 
void setPosition (edm4hep::Vector3f value)
 Set the The global position of the hit in world coordinates [mm]. More...
 
edm4hep::Vector3f & position ()
 Get reference to The global position of the hit in world coordinates [mm]. More...
 
void setDimension (edm4hep::Vector3f value)
 Set the The dimension information of the cell [mm]. More...
 
edm4hep::Vector3f & dimension ()
 Get reference to The dimension information of the cell [mm]. More...
 
void setSector (std::int32_t value)
 Set the Sector that this hit occured in. More...
 
void setLayer (std::int32_t value)
 Set the Layer that the hit occured in. More...
 
void setLocal (edm4hep::Vector3f value)
 Set the The local coordinates of the hit in the detector segment [mm]. More...
 
edm4hep::Vector3f & local ()
 Get reference to The local coordinates of the hit in the detector segment [mm]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from CalorimeterHitObj instance More...
 
bool operator== (const MutableCalorimeterHit &other) const
 
bool operator== (const CalorimeterHit &other) const
 
bool operator< (const MutableCalorimeterHit &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class CalorimeterHitCollection
 
class CalorimeterHitMutableCollectionIterator
 
class CalorimeterHit
 
void swap (MutableCalorimeterHit &a, MutableCalorimeterHit &b)
 

Detailed Description

Calorimeter hit

Author
: W. Armstrong, S. Joosten

Constructor & Destructor Documentation

◆ MutableCalorimeterHit() [1/4]

eicd::MutableCalorimeterHit::MutableCalorimeterHit ( )

default constructor

◆ MutableCalorimeterHit() [2/4]

eicd::MutableCalorimeterHit::MutableCalorimeterHit ( std::uint64_t  cellID,
float  energy,
float  energyError,
float  time,
float  timeError,
edm4hep::Vector3f  position,
edm4hep::Vector3f  dimension,
std::int32_t  sector,
std::int32_t  layer,
edm4hep::Vector3f  local 
)

◆ MutableCalorimeterHit() [3/4]

eicd::MutableCalorimeterHit::MutableCalorimeterHit ( CalorimeterHitObj obj)

constructor from existing CalorimeterHitObj

◆ MutableCalorimeterHit() [4/4]

eicd::MutableCalorimeterHit::MutableCalorimeterHit ( const MutableCalorimeterHit other)

copy constructor

◆ ~MutableCalorimeterHit()

eicd::MutableCalorimeterHit::~MutableCalorimeterHit ( )

destructor

Member Function Documentation

◆ clone()

MutableCalorimeterHit eicd::MutableCalorimeterHit::clone ( ) const

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

◆ dimension()

edm4hep::Vector3f & eicd::MutableCalorimeterHit::dimension ( )

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

◆ getCellID()

const std::uint64_t & eicd::MutableCalorimeterHit::getCellID ( ) const

Access the The detector specific (geometrical) cell id.

◆ getDimension()

const edm4hep::Vector3f & eicd::MutableCalorimeterHit::getDimension ( ) const

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

◆ getEnergy()

const float & eicd::MutableCalorimeterHit::getEnergy ( ) const

Access the The energy for this hit in [GeV].

◆ getEnergyError()

const float & eicd::MutableCalorimeterHit::getEnergyError ( ) const

Access the Error on energy [GeV].

◆ getLayer()

const std::int32_t & eicd::MutableCalorimeterHit::getLayer ( ) const

Access the Layer that the hit occured in.

◆ getLocal()

const edm4hep::Vector3f & eicd::MutableCalorimeterHit::getLocal ( ) const

Access the The local coordinates of the hit in the detector segment [mm].

◆ getObjectID()

const podio::ObjectID eicd::MutableCalorimeterHit::getObjectID ( ) const

◆ getPosition()

const edm4hep::Vector3f & eicd::MutableCalorimeterHit::getPosition ( ) const

Access the The global position of the hit in world coordinates [mm].

◆ getSector()

const std::int32_t & eicd::MutableCalorimeterHit::getSector ( ) const

Access the Sector that this hit occured in.

◆ getTime()

const float & eicd::MutableCalorimeterHit::getTime ( ) const

Access the The time of the hit in [ns].

◆ getTimeError()

const float & eicd::MutableCalorimeterHit::getTimeError ( ) const

Access the Error on the time.

◆ id()

unsigned int eicd::MutableCalorimeterHit::id ( ) const
inline

◆ isAvailable()

bool eicd::MutableCalorimeterHit::isAvailable ( ) const

check whether the object is actually available

◆ local()

edm4hep::Vector3f & eicd::MutableCalorimeterHit::local ( )

Get reference to The local coordinates of the hit in the detector segment [mm].

◆ operator CalorimeterHit()

eicd::MutableCalorimeterHit::operator CalorimeterHit ( ) const

conversion to const object

◆ operator<()

bool eicd::MutableCalorimeterHit::operator< ( const MutableCalorimeterHit other) const
inline

◆ operator=()

MutableCalorimeterHit & eicd::MutableCalorimeterHit::operator= ( MutableCalorimeterHit  other)

copy-assignment operator

◆ operator==() [1/2]

bool eicd::MutableCalorimeterHit::operator== ( const CalorimeterHit other) const

◆ operator==() [2/2]

bool eicd::MutableCalorimeterHit::operator== ( const MutableCalorimeterHit other) const
inline

◆ position()

edm4hep::Vector3f & eicd::MutableCalorimeterHit::position ( )

Get reference to The global position of the hit in world coordinates [mm].

◆ setCellID()

void eicd::MutableCalorimeterHit::setCellID ( std::uint64_t  value)

Set the The detector specific (geometrical) cell id.

◆ setDimension()

void eicd::MutableCalorimeterHit::setDimension ( edm4hep::Vector3f  value)

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

◆ setEnergy()

void eicd::MutableCalorimeterHit::setEnergy ( float  value)

Set the The energy for this hit in [GeV].

◆ setEnergyError()

void eicd::MutableCalorimeterHit::setEnergyError ( float  value)

Set the Error on energy [GeV].

◆ setLayer()

void eicd::MutableCalorimeterHit::setLayer ( std::int32_t  value)

Set the Layer that the hit occured in.

◆ setLocal()

void eicd::MutableCalorimeterHit::setLocal ( edm4hep::Vector3f  value)

Set the The local coordinates of the hit in the detector segment [mm].

◆ setPosition()

void eicd::MutableCalorimeterHit::setPosition ( edm4hep::Vector3f  value)

Set the The global position of the hit in world coordinates [mm].

◆ setSector()

void eicd::MutableCalorimeterHit::setSector ( std::int32_t  value)

Set the Sector that this hit occured in.

◆ setTime()

void eicd::MutableCalorimeterHit::setTime ( float  value)

Set the The time of the hit in [ns].

◆ setTimeError()

void eicd::MutableCalorimeterHit::setTimeError ( float  value)

Set the Error on the time.

◆ unlink()

void eicd::MutableCalorimeterHit::unlink ( )
inline

disconnect from CalorimeterHitObj instance

Friends And Related Function Documentation

◆ CalorimeterHit

friend class CalorimeterHit
friend

◆ CalorimeterHitCollection

friend class CalorimeterHitCollection
friend

◆ CalorimeterHitMutableCollectionIterator

◆ swap

void swap ( MutableCalorimeterHit a,
MutableCalorimeterHit b 
)
friend

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