edm4eic::MutableInclusiveKinematics Class Reference

#include <MutableInclusiveKinematics.h>

Public Types
using	object_type = InclusiveKinematics
using	collection_type = InclusiveKinematicsCollection

Public Member Functions
	MutableInclusiveKinematics ()
	default constructor
	MutableInclusiveKinematics (float x, float Q2, float W, float y, float nu)
	Constructor initializing all members.
	MutableInclusiveKinematics (const MutableInclusiveKinematics &other)=default
	copy constructor
MutableInclusiveKinematics &	operator= (MutableInclusiveKinematics other)
	copy-assignment operator
MutableInclusiveKinematics	clone (bool cloneRelations=true) const
	~MutableInclusiveKinematics ()=default
	destructor
float	getX () const
	Access the Bjorken x (Q2/2P.q)
float	getQ2 () const
	Access the Four-momentum transfer squared [GeV^2].
float	getW () const
	Access the Invariant mass of final state [GeV].
float	getY () const
	Access the Inelasticity (P.q/P.k)
float	getNu () const
	Access the Energy transfer P.q/M [GeV].
const edm4eic::ReconstructedParticle	getScat () const
	Access the Associated scattered electron (if identified)
void	setX (float value)
	Set the Bjorken x (Q2/2P.q)
float &	getX ()
	Get mutable reference to Bjorken x (Q2/2P.q)
float &	x ()
	Get reference to Bjorken x (Q2/2P.q)
void	setQ2 (float value)
	Set the Four-momentum transfer squared [GeV^2].
float &	getQ2 ()
	Get mutable reference to Four-momentum transfer squared [GeV^2].
float &	Q2 ()
	Get reference to Four-momentum transfer squared [GeV^2].
void	setW (float value)
	Set the Invariant mass of final state [GeV].
float &	getW ()
	Get mutable reference to Invariant mass of final state [GeV].
float &	W ()
	Get reference to Invariant mass of final state [GeV].
void	setY (float value)
	Set the Inelasticity (P.q/P.k)
float &	getY ()
	Get mutable reference to Inelasticity (P.q/P.k)
float &	y ()
	Get reference to Inelasticity (P.q/P.k)
void	setNu (float value)
	Set the Energy transfer P.q/M [GeV].
float &	getNu ()
	Get mutable reference to Energy transfer P.q/M [GeV].
float &	nu ()
	Get reference to Energy transfer P.q/M [GeV].
void	setScat (const edm4eic::ReconstructedParticle &value)
	Set the Associated scattered electron (if identified)
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from InclusiveKinematicsObj instance
bool	operator== (const MutableInclusiveKinematics &other) const
bool	operator== (const InclusiveKinematics &other) const
bool	operator!= (const MutableInclusiveKinematics &other) const
bool	operator!= (const InclusiveKinematics &other) const
bool	operator< (const MutableInclusiveKinematics &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Friends
class	InclusiveKinematicsCollection
class	InclusiveKinematicsMutableCollectionIterator
class	InclusiveKinematics
void	swap (MutableInclusiveKinematics &a, MutableInclusiveKinematics &b)

Detailed Description

Kinematic variables for DIS events

Author

: S. Joosten, W. Deconinck

Member Typedef Documentation

collection_type

using edm4eic::MutableInclusiveKinematics::collection_type = InclusiveKinematicsCollection

object_type

using edm4eic::MutableInclusiveKinematics::object_type = InclusiveKinematics

Constructor & Destructor Documentation

MutableInclusiveKinematics() [1/3]

edm4eic::MutableInclusiveKinematics::MutableInclusiveKinematics

(

)

default constructor

MutableInclusiveKinematics() [2/3]

edm4eic::MutableInclusiveKinematics::MutableInclusiveKinematics	(	float	x,
		float	Q2,
		float	W,
		float	y,
		float	nu )

Constructor initializing all members.

MutableInclusiveKinematics() [3/3]

edm4eic::MutableInclusiveKinematics::MutableInclusiveKinematics ( const MutableInclusiveKinematics & other )

default

copy constructor

~MutableInclusiveKinematics()

edm4eic::MutableInclusiveKinematics::~MutableInclusiveKinematics ( )

default

destructor

Member Function Documentation

clone()

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

getNu() [1/2]

float & edm4eic::MutableInclusiveKinematics::getNu

(

)

Get mutable reference to Energy transfer P.q/M [GeV].

getNu() [2/2]

float edm4eic::MutableInclusiveKinematics::getNu

(

)

const

Access the Energy transfer P.q/M [GeV].

getObjectID()

const podio::ObjectID edm4eic::MutableInclusiveKinematics::getObjectID

(

)

const

getQ2() [1/2]

float & edm4eic::MutableInclusiveKinematics::getQ2

(

)

Get mutable reference to Four-momentum transfer squared [GeV^2].

getQ2() [2/2]

float edm4eic::MutableInclusiveKinematics::getQ2

(

)

const

Access the Four-momentum transfer squared [GeV^2].

getScat()

const edm4eic::ReconstructedParticle edm4eic::MutableInclusiveKinematics::getScat

(

)

const

Access the Associated scattered electron (if identified)

getW() [1/2]

float & edm4eic::MutableInclusiveKinematics::getW

(

)

Get mutable reference to Invariant mass of final state [GeV].

getW() [2/2]

float edm4eic::MutableInclusiveKinematics::getW

(

)

const

Access the Invariant mass of final state [GeV].

getX() [1/2]

float & edm4eic::MutableInclusiveKinematics::getX

(

)

Get mutable reference to Bjorken x (Q2/2P.q)

getX() [2/2]

float edm4eic::MutableInclusiveKinematics::getX

(

)

const

Access the Bjorken x (Q2/2P.q)

getY() [1/2]

float & edm4eic::MutableInclusiveKinematics::getY

(

)

Get mutable reference to Inelasticity (P.q/P.k)

getY() [2/2]

float edm4eic::MutableInclusiveKinematics::getY

(

)

const

Access the Inelasticity (P.q/P.k)

id()

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

inline

isAvailable()

bool edm4eic::MutableInclusiveKinematics::isAvailable

(

)

const

check whether the object is actually available

nu()

float & edm4eic::MutableInclusiveKinematics::nu

(

)

Get reference to Energy transfer P.q/M [GeV].

operator!=() [1/2]

bool edm4eic::MutableInclusiveKinematics::operator!= ( const InclusiveKinematics & other ) const

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=()

MutableInclusiveKinematics & edm4eic::MutableInclusiveKinematics::operator=

(

MutableInclusiveKinematics

other

)

copy-assignment operator

operator==() [1/2]

bool edm4eic::MutableInclusiveKinematics::operator==

(

const InclusiveKinematics &

other

)

const

operator==() [2/2]

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

inline

Q2()

float & edm4eic::MutableInclusiveKinematics::Q2

(

)

Get reference to Four-momentum transfer squared [GeV^2].

setNu()

void edm4eic::MutableInclusiveKinematics::setNu

(

float

value

)

Set the Energy transfer P.q/M [GeV].

setQ2()

void edm4eic::MutableInclusiveKinematics::setQ2

(

float

value

)

Set the Four-momentum transfer squared [GeV^2].

setScat()

void edm4eic::MutableInclusiveKinematics::setScat

(

const edm4eic::ReconstructedParticle &

value

)

Set the Associated scattered electron (if identified)

setW()

void edm4eic::MutableInclusiveKinematics::setW

(

float

value

)

Set the Invariant mass of final state [GeV].

setX()

void edm4eic::MutableInclusiveKinematics::setX

(

float

value

)

Set the Bjorken x (Q2/2P.q)

setY()

void edm4eic::MutableInclusiveKinematics::setY

(

float

value

)

Set the Inelasticity (P.q/P.k)

unlink()

void edm4eic::MutableInclusiveKinematics::unlink ( )

inline

disconnect from InclusiveKinematicsObj instance

W()

float & edm4eic::MutableInclusiveKinematics::W

(

)

Get reference to Invariant mass of final state [GeV].

x()

float & edm4eic::MutableInclusiveKinematics::x

(

)

Get reference to Bjorken x (Q2/2P.q)

y()

float & edm4eic::MutableInclusiveKinematics::y

(

)

Get reference to Inelasticity (P.q/P.k)

Friends And Related Symbol Documentation

InclusiveKinematics

friend class InclusiveKinematics

friend

InclusiveKinematicsCollection

friend class InclusiveKinematicsCollection

friend

InclusiveKinematicsMutableCollectionIterator

friend class InclusiveKinematicsMutableCollectionIterator

friend

swap

void swap ( MutableInclusiveKinematics & a, MutableInclusiveKinematics & b )

friend

---

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

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