edm4eic::MutableCalorimeterHit Class Reference

#include <MutableCalorimeterHit.h>

Public Types
using	object_type = CalorimeterHit
using	collection_type = CalorimeterHitCollection

Public Member Functions
	MutableCalorimeterHit ()
	default constructor
	MutableCalorimeterHit (const std::uint64_t cellID, const float energy, const float energyError, const float time, const float timeError, const edm4hep::Vector3f &position, const edm4hep::Vector3f &dimension, const std::int32_t sector, const std::int32_t layer, const edm4hep::Vector3f &local)
	Constructor initializing all members.
	MutableCalorimeterHit (const MutableCalorimeterHit &other)=default
	copy constructor
MutableCalorimeterHit &	operator= (MutableCalorimeterHit other) &
	copy-assignment operator
MutableCalorimeterHit &	operator= (MutableCalorimeterHit other) &&=delete
MutableCalorimeterHit	clone (bool cloneRelations=true) const
	~MutableCalorimeterHit ()=default
	destructor
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 (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	setEnergy (const float energy)
	Set the The energy for this hit in [GeV].
float &	getEnergy ()
	Get mutable reference to The energy for this hit in [GeV].
float &	energy ()
	Get reference to The energy for this hit in [GeV].
void	setEnergyError (const float energyError)
	Set the Error on energy [GeV].
float &	getEnergyError ()
	Get mutable reference to Error on energy [GeV].
float &	energyError ()
	Get reference to Error on energy [GeV].
void	setTime (const float time)
	Set the The time of the hit in [ns].
float &	getTime ()
	Get mutable reference to The time of the hit in [ns].
float &	time ()
	Get reference to The time of the hit in [ns].
void	setTimeError (const float timeError)
	Set the Error on the time.
float &	getTimeError ()
	Get mutable reference to Error on the time.
float &	timeError ()
	Get reference to Error on the time.
void	setPosition (const edm4hep::Vector3f &position)
	Set the The global position of the hit in world coordinates [mm].
edm4hep::Vector3f &	getPosition ()
	Get mutable reference to 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 (const edm4hep::Vector3f &dimension)
	Set the The dimension information of the cell [mm].
edm4hep::Vector3f &	getDimension ()
	Get mutable reference to The dimension information of the cell [mm].
edm4hep::Vector3f &	dimension ()
	Get reference to The dimension information of the cell [mm].
void	setSector (const std::int32_t sector)
	Set the Sector that this hit occurred in.
std::int32_t &	getSector ()
	Get mutable reference to Sector that this hit occurred in.
std::int32_t &	sector ()
	Get reference to Sector that this hit occurred in.
void	setLayer (const std::int32_t layer)
	Set the Layer that the hit occurred in.
std::int32_t &	getLayer ()
	Get mutable reference to Layer that the hit occurred in.
std::int32_t &	layer ()
	Get reference to Layer that the hit occurred in.
void	setLocal (const edm4hep::Vector3f &local)
	Set the The local coordinates of the hit in the detector segment [mm].
edm4hep::Vector3f &	getLocal ()
	Get mutable reference to 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 (const 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
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	(	const std::uint64_t	cellID,
		const float	energy,
		const float	energyError,
		const float	time,
		const float	timeError,
		const edm4hep::Vector3f &	position,
		const edm4hep::Vector3f &	dimension,
		const std::int32_t	sector,
		const std::int32_t	layer,
		const 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

cellID()

std::uint64_t & edm4eic::MutableCalorimeterHit::cellID

(

)

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

clone()

MutableCalorimeterHit edm4eic::MutableCalorimeterHit::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::MutableCalorimeterHit::dimension

(

)

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

energy()

float & edm4eic::MutableCalorimeterHit::energy

(

)

Get reference to The energy for this hit in [GeV].

energyError()

float & edm4eic::MutableCalorimeterHit::energyError

(

)

Get reference to Error on energy [GeV].

getCellID() [1/2]

std::uint64_t & edm4eic::MutableCalorimeterHit::getCellID

(

)

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

getCellID() [2/2]

std::uint64_t edm4eic::MutableCalorimeterHit::getCellID

(

)

const

Access the The detector specific (geometrical) cell id.

getDimension() [1/2]

edm4hep::Vector3f & edm4eic::MutableCalorimeterHit::getDimension

(

)

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

getDimension() [2/2]

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

(

)

const

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

getEnergy() [1/2]

float & edm4eic::MutableCalorimeterHit::getEnergy

(

)

Get mutable reference to The energy for this hit in [GeV].

getEnergy() [2/2]

float edm4eic::MutableCalorimeterHit::getEnergy

(

)

const

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

getEnergyError() [1/2]

float & edm4eic::MutableCalorimeterHit::getEnergyError

(

)

Get mutable reference to Error on energy [GeV].

getEnergyError() [2/2]

float edm4eic::MutableCalorimeterHit::getEnergyError

(

)

const

Access the Error on energy [GeV].

getLayer() [1/2]

std::int32_t & edm4eic::MutableCalorimeterHit::getLayer

(

)

Get mutable reference to Layer that the hit occurred in.

getLayer() [2/2]

std::int32_t edm4eic::MutableCalorimeterHit::getLayer

(

)

const

Access the Layer that the hit occurred in.

getLocal() [1/2]

edm4hep::Vector3f & edm4eic::MutableCalorimeterHit::getLocal

(

)

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

getLocal() [2/2]

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() [1/2]

edm4hep::Vector3f & edm4eic::MutableCalorimeterHit::getPosition

(

)

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

getPosition() [2/2]

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() [1/2]

std::int32_t & edm4eic::MutableCalorimeterHit::getSector

(

)

Get mutable reference to Sector that this hit occurred in.

getSector() [2/2]

std::int32_t edm4eic::MutableCalorimeterHit::getSector

(

)

const

Access the Sector that this hit occurred in.

getTime() [1/2]

float & edm4eic::MutableCalorimeterHit::getTime

(

)

Get mutable reference to The time of the hit in [ns].

getTime() [2/2]

float edm4eic::MutableCalorimeterHit::getTime

(

)

const

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

getTimeError() [1/2]

float & edm4eic::MutableCalorimeterHit::getTimeError

(

)

Get mutable reference to Error on the time.

getTimeError() [2/2]

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

layer()

std::int32_t & edm4eic::MutableCalorimeterHit::layer

(

)

Get reference to Layer that the hit occurred in.

local()

edm4hep::Vector3f & edm4eic::MutableCalorimeterHit::local

(

)

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

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

MutableCalorimeterHit & edm4eic::MutableCalorimeterHit::operator=

(

MutableCalorimeterHit

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

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

sector()

std::int32_t & edm4eic::MutableCalorimeterHit::sector

(

)

Get reference to Sector that this hit occurred in.

setCellID()

void edm4eic::MutableCalorimeterHit::setCellID

(

const std::uint64_t

cellID

)

Set the The detector specific (geometrical) cell id.

setDimension()

void edm4eic::MutableCalorimeterHit::setDimension

(

const edm4hep::Vector3f &

dimension

)

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

setEnergy()

void edm4eic::MutableCalorimeterHit::setEnergy

(

const float

energy

)

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

setEnergyError()

void edm4eic::MutableCalorimeterHit::setEnergyError

(

const float

energyError

)

Set the Error on energy [GeV].

setLayer()

void edm4eic::MutableCalorimeterHit::setLayer

(

const std::int32_t

layer

)

Set the Layer that the hit occurred in.

setLocal()

void edm4eic::MutableCalorimeterHit::setLocal

(

const edm4hep::Vector3f &

local

)

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

setPosition()

void edm4eic::MutableCalorimeterHit::setPosition

(

const edm4hep::Vector3f &

position

)

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

setRawHit()

void edm4eic::MutableCalorimeterHit::setRawHit

(

const edm4hep::RawCalorimeterHit &

value

)

Set the Related raw calorimeter hit.

setSector()

void edm4eic::MutableCalorimeterHit::setSector

(

const std::int32_t

sector

)

Set the Sector that this hit occurred in.

setTime()

void edm4eic::MutableCalorimeterHit::setTime

(

const float

time

)

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

setTimeError()

void edm4eic::MutableCalorimeterHit::setTimeError

(

const float

timeError

)

Set the Error on the time.

time()

float & edm4eic::MutableCalorimeterHit::time

(

)

Get reference to The time of the hit in [ns].

timeError()

float & edm4eic::MutableCalorimeterHit::timeError

(

)

Get reference to 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:

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