edm4eic::InclusiveKinematics Class Reference

#include <InclusiveKinematics.h>

Public Types
using	mutable_type = MutableInclusiveKinematics
using	collection_type = InclusiveKinematicsCollection

Public Member Functions
	InclusiveKinematics ()=default
	default constructor
	InclusiveKinematics (const float x, const float Q2, const float W, const float y, const float nu)
	Constructor initializing all members.
	InclusiveKinematics (const InclusiveKinematics &other)=default
	copy constructor
InclusiveKinematics &	operator= (InclusiveKinematics other) &
	copy-assignment operator
InclusiveKinematics &	operator= (InclusiveKinematics other) &&=delete
MutableInclusiveKinematics	clone (bool cloneRelations=true) const
	~InclusiveKinematics ()=default
	destructor
	InclusiveKinematics (const MutableInclusiveKinematics &other)
	converting constructor from mutable object
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).
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from InclusiveKinematicsObj instance
bool	operator== (const InclusiveKinematics &other) const
bool	operator== (const MutableInclusiveKinematics &other) const
bool	operator!= (const InclusiveKinematics &other) const
bool	operator!= (const MutableInclusiveKinematics &other) const
bool	operator< (const InclusiveKinematics &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static InclusiveKinematics	makeEmpty ()

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::InclusiveKinematics"

Friends
class	MutableInclusiveKinematics
class	InclusiveKinematicsCollection
class	edm4eic::InclusiveKinematicsCollectionData
class	InclusiveKinematicsCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const InclusiveKinematics &obj)
void	swap (InclusiveKinematics &a, InclusiveKinematics &b)

Detailed Description

Kinematic variables for DIS events

Author

: S. Joosten, W. Deconinck

Member Typedef Documentation

collection_type

using edm4eic::InclusiveKinematics::collection_type = InclusiveKinematicsCollection

mutable_type

using edm4eic::InclusiveKinematics::mutable_type = MutableInclusiveKinematics

Constructor & Destructor Documentation

InclusiveKinematics() [1/4]

edm4eic::InclusiveKinematics::InclusiveKinematics ( )

default

default constructor

InclusiveKinematics() [2/4]

edm4eic::InclusiveKinematics::InclusiveKinematics	(	const float	x,
		const float	Q2,
		const float	W,
		const float	y,
		const float	nu )

Constructor initializing all members.

InclusiveKinematics() [3/4]

edm4eic::InclusiveKinematics::InclusiveKinematics ( const InclusiveKinematics & other )

default

copy constructor

~InclusiveKinematics()

edm4eic::InclusiveKinematics::~InclusiveKinematics ( )

default

destructor

InclusiveKinematics() [4/4]

edm4eic::InclusiveKinematics::InclusiveKinematics

(

const MutableInclusiveKinematics &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableInclusiveKinematics edm4eic::InclusiveKinematics::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()

float edm4eic::InclusiveKinematics::getNu

(

)

const

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

getObjectID()

const podio::ObjectID edm4eic::InclusiveKinematics::getObjectID

(

)

const

getQ2()

float edm4eic::InclusiveKinematics::getQ2

(

)

const

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

getScat()

const edm4eic::ReconstructedParticle edm4eic::InclusiveKinematics::getScat

(

)

const

Access the Associated scattered electron (if identified).

getW()

float edm4eic::InclusiveKinematics::getW

(

)

const

Access the Invariant mass of final state [GeV].

getX()

float edm4eic::InclusiveKinematics::getX

(

)

const

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

getY()

float edm4eic::InclusiveKinematics::getY

(

)

const

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

id()

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

inline

isAvailable()

bool edm4eic::InclusiveKinematics::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

InclusiveKinematics edm4eic::InclusiveKinematics::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

InclusiveKinematics & edm4eic::InclusiveKinematics::operator=

(

InclusiveKinematics

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::InclusiveKinematics::operator==

(

const MutableInclusiveKinematics &

other

)

const

unlink()

void edm4eic::InclusiveKinematics::unlink ( )

inline

disconnect from InclusiveKinematicsObj instance

Friends And Related Symbol Documentation

edm4eic::InclusiveKinematicsCollectionData

friend class edm4eic::InclusiveKinematicsCollectionData

friend

InclusiveKinematicsCollection

friend class InclusiveKinematicsCollection

friend

InclusiveKinematicsCollectionIterator

friend class InclusiveKinematicsCollectionIterator

friend

MutableInclusiveKinematics

friend class MutableInclusiveKinematics

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const InclusiveKinematics & obj )

friend

swap

void swap ( InclusiveKinematics & a, InclusiveKinematics & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::InclusiveKinematics::typeName = "edm4eic::InclusiveKinematics"

staticconstexpr

---

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

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