EDM4eic
EIC data model
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
edm4eic::MutableCalorimeterHit Class Reference

#include <MutableCalorimeterHit.h>

Public Types

using object_type = CalorimeterHit
 
using collection_type = CalorimeterHitCollection
 

Public Member Functions

 MutableCalorimeterHit ()
 default constructor
 
 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)
 Constructor initializing all members.
 
 MutableCalorimeterHit (const MutableCalorimeterHit &other)=default
 copy constructor
 
MutableCalorimeterHit & operator= (MutableCalorimeterHit other)
 copy-assignment operator
 
MutableCalorimeterHit clone () const
 create a mutable deep-copy of the object with identical relations
 
 ~MutableCalorimeterHit ()=default
 destructor
 
 operator CalorimeterHit () const
 conversion to const object
 
std::uint64_t getCellID () const
 Access the The detector specific (geometrical) cell id.
 
float getEnergy () const
 Access the The energy for this hit in [GeV].
 
float getEnergyError () const
 Access the Error on energy [GeV].
 
float getTime () const
 Access the The time of the hit in [ns].
 
float getTimeError () const
 Access the Error on the time.
 
const edm4hep::Vector3f & getPosition () const
 Access the The global position of the hit in world coordinates [mm].
 
const edm4hep::Vector3f & getDimension () const
 Access the The dimension information of the cell [mm].
 
std::int32_t getSector () const
 Access the Sector that this hit occurred in.
 
std::int32_t getLayer () const
 Access the Layer that the hit occurred in.
 
const edm4hep::Vector3f & getLocal () const
 Access the The local coordinates of the hit in the detector segment [mm].
 
const edm4hep::RawCalorimeterHit getRawHit () const
 Access the Related raw calorimeter hit.
 
void setCellID (std::uint64_t value)
 Set the The detector specific (geometrical) cell id.
 
void setEnergy (float value)
 Set the The energy for this hit in [GeV].
 
void setEnergyError (float value)
 Set the Error on energy [GeV].
 
void setTime (float value)
 Set the The time of the hit in [ns].
 
void setTimeError (float value)
 Set the Error on the time.
 
void setPosition (edm4hep::Vector3f value)
 Set the The global position of the hit in world coordinates [mm].
 
edm4hep::Vector3f & position ()
 Get reference to The global position of the hit in world coordinates [mm].
 
void setDimension (edm4hep::Vector3f value)
 Set the The dimension information of the cell [mm].
 
edm4hep::Vector3f & dimension ()
 Get reference to The dimension information of the cell [mm].
 
void setSector (std::int32_t value)
 Set the Sector that this hit occurred in.
 
void setLayer (std::int32_t value)
 Set the Layer that the hit occurred in.
 
void setLocal (edm4hep::Vector3f value)
 Set the The local coordinates of the hit in the detector segment [mm].
 
edm4hep::Vector3f & local ()
 Get reference to The local coordinates of the hit in the detector segment [mm].
 
void setRawHit (edm4hep::RawCalorimeterHit value)
 Set the Related raw calorimeter hit.
 
bool isAvailable () const
 check whether the object is actually available
 
void unlink ()
 disconnect from CalorimeterHitObj instance
 
bool operator== (const MutableCalorimeterHit &other) const
 
bool operator== (const CalorimeterHit &other) const
 
bool operator< (const MutableCalorimeterHit &other) const
 
podio::ObjectID 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

Member Typedef Documentation

◆ collection_type

using edm4eic::MutableCalorimeterHit::collection_type = CalorimeterHitCollection

◆ object_type

using edm4eic::MutableCalorimeterHit::object_type = CalorimeterHit

Constructor & Destructor Documentation

◆ MutableCalorimeterHit() [1/3]

edm4eic::MutableCalorimeterHit::MutableCalorimeterHit ( )

default constructor

◆ MutableCalorimeterHit() [2/3]

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

Constructor initializing all members.

◆ MutableCalorimeterHit() [3/3]

edm4eic::MutableCalorimeterHit::MutableCalorimeterHit ( const MutableCalorimeterHit & other)
default

copy constructor

◆ ~MutableCalorimeterHit()

edm4eic::MutableCalorimeterHit::~MutableCalorimeterHit ( )
default

destructor

Member Function Documentation

◆ clone()

MutableCalorimeterHit edm4eic::MutableCalorimeterHit::clone ( ) const

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

◆ dimension()

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

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

◆ getCellID()

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

Access the The detector specific (geometrical) cell id.

◆ getDimension()

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

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

◆ getEnergy()

float edm4eic::MutableCalorimeterHit::getEnergy ( ) const

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

◆ getEnergyError()

float edm4eic::MutableCalorimeterHit::getEnergyError ( ) const

Access the Error on energy [GeV].

◆ getLayer()

std::int32_t edm4eic::MutableCalorimeterHit::getLayer ( ) const

Access the Layer that the hit occurred in.

◆ getLocal()

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

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

◆ getObjectID()

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

◆ getPosition()

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

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

◆ getRawHit()

const edm4hep::RawCalorimeterHit edm4eic::MutableCalorimeterHit::getRawHit ( ) const

Access the Related raw calorimeter hit.

◆ getSector()

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

Access the Sector that this hit occurred in.

◆ getTime()

float edm4eic::MutableCalorimeterHit::getTime ( ) const

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

◆ getTimeError()

float edm4eic::MutableCalorimeterHit::getTimeError ( ) const

Access the Error on the time.

◆ id()

podio::ObjectID edm4eic::MutableCalorimeterHit::id ( ) const
inline

◆ isAvailable()

bool edm4eic::MutableCalorimeterHit::isAvailable ( ) const

check whether the object is actually available

◆ local()

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

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

◆ operator CalorimeterHit()

edm4eic::MutableCalorimeterHit::operator CalorimeterHit ( ) const

conversion to const object

◆ operator<()

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

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

bool edm4eic::MutableCalorimeterHit::operator== ( const CalorimeterHit & other) const

◆ operator==() [2/2]

bool edm4eic::MutableCalorimeterHit::operator== ( const MutableCalorimeterHit & other) const
inline

◆ position()

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

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

◆ setCellID()

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

Set the The detector specific (geometrical) cell id.

◆ setDimension()

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

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

◆ setEnergy()

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

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

◆ setEnergyError()

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

Set the Error on energy [GeV].

◆ setLayer()

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

Set the Layer that the hit occurred in.

◆ setLocal()

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

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

◆ setPosition()

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

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

◆ setRawHit()

void edm4eic::MutableCalorimeterHit::setRawHit ( edm4hep::RawCalorimeterHit value)

Set the Related raw calorimeter hit.

◆ setSector()

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

Set the Sector that this hit occurred in.

◆ setTime()

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

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

◆ setTimeError()

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

Set the Error on the time.

◆ unlink()

void edm4eic::MutableCalorimeterHit::unlink ( )
inline

disconnect from CalorimeterHitObj instance

Friends And Related Symbol Documentation

◆ CalorimeterHit

friend class CalorimeterHit
friend

◆ CalorimeterHitCollection

friend class CalorimeterHitCollection
friend

◆ CalorimeterHitMutableCollectionIterator

friend class CalorimeterHitMutableCollectionIterator
friend

◆ swap

void swap ( MutableCalorimeterHit & a,
MutableCalorimeterHit & b )
friend
The documentation for this class was generated from the following files: