PARTONS::DVMPObservableKinematic Class Reference

Class representing single observable kinematics for DVMP process. More...

Inheritance diagram for PARTONS::DVMPObservableKinematic:

Public Member Functions
	DVMPObservableKinematic ()
	Default constructor. More...
	DVMPObservableKinematic (double xB, double t, double Q2, double E, double phi, MesonType::Type mesonType)
	Assignment constructor. More...
	DVMPObservableKinematic (const PhysicalType< double > &xB, const PhysicalType< double > &t, const PhysicalType< double > &Q2, const PhysicalType< double > &E, const PhysicalType< double > &phi, MesonType::Type mesonType)
	Assignment constructor. More...
	DVMPObservableKinematic (const ElemUtils::GenericType &xB, const ElemUtils::GenericType &t, const ElemUtils::GenericType &Q2, const ElemUtils::GenericType &E, const ElemUtils::GenericType &phi, MesonType::Type mesonType)
	Assignment constructor. More...
	DVMPObservableKinematic (const DVMPObservableKinematic &other)
	Copy constructor. More...
virtual	~DVMPObservableKinematic ()
	Destructor. More...
virtual void	configure (const ElemUtils::Parameters &parameters)
	Configure via parameters. More...
virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...
void	serialize (ElemUtils::Packet &packet) const
	Serialize into given Packet. More...
void	unserialize (ElemUtils::Packet &packet)
	Retrieve data from given Packet. More...
void	serializeIntoStdVector (std::vector< double > &vec) const
	Serialize to std::vector<double>. More...
void	unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
	Unserialize from std::vector<double>. More...
bool	operator== (const DVMPObservableKinematic &other) const
	Is equal operator. More...
bool	operator!= (const DVMPObservableKinematic &other) const
	Is different operator. More...
const PhysicalType< double > &	getXB () const
	Get Bjorken variable. More...
void	setXB (const PhysicalType< double > &xB)
	Set Bjorken variable. More...
void	setXB (double xB, PhysicalUnit::Type unit=PhysicalUnit::NONE)
	Set Bjorken variable. More...
const PhysicalType< double > &	getT () const
	Get four-momentum transfer squared of hadron target. More...
void	setT (const PhysicalType< double > &t)
	Set four-momentum transfer squared of hadron target. More...
void	setT (double t, PhysicalUnit::Type unit=PhysicalUnit::GEV2)
	Set four-momentum transfer squared of hadron target. More...
const PhysicalType< double > &	getQ2 () const
	Get virtual-photon virtuality. More...
void	setQ2 (const PhysicalType< double > &Q2)
	Set virtual-photon virtuality. More...
void	setQ2 (double Q2, PhysicalUnit::Type unit=PhysicalUnit::GEV2)
	Set virtual-photon virtuality. More...
const PhysicalType< double > &	getE () const
	Get beam energy. More...
void	setE (const PhysicalType< double > &E)
	Set beam energy. More...
void	setE (double E, PhysicalUnit::Type unit=PhysicalUnit::GEV)
	Set beam energy. More...
const PhysicalType< double > &	getPhi () const
	Get angle between leptonic and hadronic planes (in radians). More...
void	setPhi (const PhysicalType< double > &phi)
	Set angle between leptonic and hadronic planes (in radians). More...
void	setPhi (double phi, PhysicalUnit::Type unit=PhysicalUnit::RAD)
	Set angle between leptonic and hadronic planes (in radians). More...
MesonType::Type	getMesonType () const
	Get meson type. More...
void	setMesonType (MesonType::Type mesonType)
	Set meson type. More...
Public Member Functions inherited from PARTONS::ObservableKinematic
virtual	~ObservableKinematic ()
	Destructor. More...
void	serialize (ElemUtils::Packet &packet) const
	Serialize into given Packet. More...
void	unserialize (ElemUtils::Packet &packet)
	Retrieve data from given Packet. More...
void	serializeIntoStdVector (std::vector< double > &vec) const
	Serialize to std::vector<double>. More...
void	unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
	Unserialize from std::vector<double>. More...
Public Member Functions inherited from PARTONS::Kinematic
virtual	~Kinematic ()
	Destructor. More...
void	serialize (ElemUtils::Packet &packet) const
	Serialize into given Packet. More...
void	unserialize (ElemUtils::Packet &packet)
	Retrieve data from given Packet. More...
void	serializeIntoStdVector (std::vector< double > &vec) const
	Serialize to std::vector<double>. More...
void	unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
	Unserialize from std::vector<double>. More...
ChannelType::Type	getChannelType () const
	Get channel type. More...
const std::string &	getHashSum () const
	Get hash sum of class content. More...
void	setHashSum (const std::string &hashSum) const
	Set hash sum of class content. More...
Public Member Functions inherited from PARTONS::BaseObject
	BaseObject (const std::string &className)
	Constructor. More...
virtual	~BaseObject ()
	Default destructor. More...
virtual BaseObject *	clone () const
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
virtual void	resolveObjectDependencies ()
	Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others. More...
void	serialize (ElemUtils::Packet &packet) const
	Used to split a complex C++ object into a concatenation of simple types. More...
void	unserialize (ElemUtils::Packet &packet)
	Used to rebuild a complex C++ object from a concatenation of simple type. More...
bool	operator< (const BaseObject &other) const
	Overload of < operator to sort BaseObject object by its indexId value. More...
const std::string &	getClassName () const
unsigned int	getObjectId () const
int	getIndexId () const
void	setIndexId (int indexId)

Static Public Attributes
static const std::string	DVMP_OBSERVABLE_KNEMATIC_CLASS_NAME
	Type of the kinematic in XML automation. More...
static const std::string	KINEMATIC_PARAMETER_NAME_XB = "xB"
	Parameter name to set variable \(x_{B}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_Q2 = "Q2"
	Parameter name to set variable \(Q^{2}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_BEAM_ENERGY
	Parameter name to set variable \(E_{b}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_PHI = "phi"
	Parameter name to set variable \(\phi\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_MESON_TYPE
	Parameter name to set meson type via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_XB_UNIT
	Parameter name to set unit of variable \(x_{B}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_Q2_UNIT
	Parameter name to set unit of variable \(Q^{2}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_BEAM_ENERGY_UNIT
	Parameter name to set unit of variable \(E_{b}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_PHI_UNIT
	Parameter name to set unit of variable \(\phi\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_MESON_TYPE_UNIT
	Parameter name to set unit of meson type via configuration methods. More...

Protected Member Functions
virtual void	updateHashSum () const
	Update hash sum (see Kinematic::m_hashSum variable). More...
Protected Member Functions inherited from PARTONS::ObservableKinematic
	ObservableKinematic (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...
	ObservableKinematic (const ObservableKinematic &other)
	Copy constructor. More...
Protected Member Functions inherited from PARTONS::Kinematic
	Kinematic (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...
	Kinematic (const Kinematic &other)
	Copy constructor. More...
Protected Member Functions inherited from PARTONS::BaseObject
	BaseObject (const BaseObject &other)
	Copy constructor. More...
void	info (const std::string &functionName, const std::string &message) const
	Print info message into logger. More...
void	debug (const std::string &functionName, const std::string &message) const
	Print debug message into logger. More...
void	warn (const std::string &functionName, const std::string &message) const
	Print warning message into logger. More...
void	errorMissingParameter (const std::string &parameterName) const
	Use in automation process to throw exception when a parameter is missing from the XML scenario file. More...

Private Attributes
PhysicalType< double >	m_xB
	Bjorken variable. More...
PhysicalType< double >	m_t
	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)). More...
PhysicalType< double >	m_Q2
	Virtual-photon virtuality (in \(GeV^{2}\)). More...
PhysicalType< double >	m_E
	Beam energy (in GeV). More...
PhysicalType< double >	m_phi
	Angle between leptonic and hadronic planes (in radians, Trento convention). More...
MesonType::Type	m_mesonType
	Meson type. More...

Detailed Description

Class representing single observable kinematics for DVMP process.

This class represents a single observable kinematics for DVMP process (x_{B}, t, \(Q^{2}\), E_{b}, \(\phi\), mesonType).

Constructor & Destructor Documentation

DVMPObservableKinematic() [1/5]

PARTONS::DVMPObservableKinematic::DVMPObservableKinematic

(

)

Default constructor.

DVMPObservableKinematic() [2/5]

PARTONS::DVMPObservableKinematic::DVMPObservableKinematic	(	double	xB,
		double	t,
		double	Q2,
		double	E,
		double	phi,
		MesonType::Type	mesonType
	)

Assignment constructor.

Parameters

xB	Bjorken variable.
t	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).
Q2	Virtual-photon virtuality (in \(GeV^{2}\)).
E	Beam energy (in GeV).
phi	Angle between leptonic and hadronic planes (in radians, Trento convention).
mesonType	Meson type.

DVMPObservableKinematic() [3/5]

PARTONS::DVMPObservableKinematic::DVMPObservableKinematic	(	const PhysicalType< double > &	xB,
		const PhysicalType< double > &	t,
		const PhysicalType< double > &	Q2,
		const PhysicalType< double > &	E,
		const PhysicalType< double > &	phi,
		MesonType::Type	mesonType
	)

Assignment constructor.

Parameters

xB	Bjorken variable.
t	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).
Q2	Virtual-photon virtuality (in \(GeV^{2}\)).
E	Beam energy (in GeV).
phi	Angle between leptonic and hadronic planes (in radians, Trento convention).
mesonType	Meson type.

DVMPObservableKinematic() [4/5]

PARTONS::DVMPObservableKinematic::DVMPObservableKinematic	(	const ElemUtils::GenericType &	xB,
		const ElemUtils::GenericType &	t,
		const ElemUtils::GenericType &	Q2,
		const ElemUtils::GenericType &	E,
		const ElemUtils::GenericType &	phi,
		MesonType::Type	mesonType
	)

Assignment constructor.

Parameters

xB	Bjorken variable.
t	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).
Q2	Virtual-photon virtuality (in \(GeV^{2}\)).
E	Beam energy (in GeV).
phi	Angle between leptonic and hadronic planes (in radians, Trento convention).
mesonType	Meson type.

DVMPObservableKinematic() [5/5]

PARTONS::DVMPObservableKinematic::DVMPObservableKinematic

(

const DVMPObservableKinematic &

other

)

Copy constructor.

Parameters

other

Object to be copied.

~DVMPObservableKinematic()

PARTONS::DVMPObservableKinematic::~DVMPObservableKinematic ( )

virtual

Destructor.

Member Function Documentation

configure()

void PARTONS::DVMPObservableKinematic::configure ( const ElemUtils::Parameters &  parameters )

virtual

Configure via parameters.

Parameters

parameters

Set of parameters to be set.

Reimplemented from PARTONS::ObservableKinematic.

getE()

const PhysicalType< double > & PARTONS::DVMPObservableKinematic::getE

(

)

const

Get beam energy.

getMesonType()

MesonType::Type PARTONS::DVMPObservableKinematic::getMesonType

(

)

const

Get meson type.

getPhi()

const PhysicalType< double > & PARTONS::DVMPObservableKinematic::getPhi

(

)

const

Get angle between leptonic and hadronic planes (in radians).

getQ2()

const PhysicalType< double > & PARTONS::DVMPObservableKinematic::getQ2

(

)

const

Get virtual-photon virtuality.

getT()

const PhysicalType< double > & PARTONS::DVMPObservableKinematic::getT

(

)

const

Get four-momentum transfer squared of hadron target.

getXB()

const PhysicalType< double > & PARTONS::DVMPObservableKinematic::getXB

(

)

const

Get Bjorken variable.

operator!=()

bool PARTONS::DVMPObservableKinematic::operator!=

(

const DVMPObservableKinematic &

other

)

const

Is different operator.

Checks of values of kinematic variables are different.

operator==()

bool PARTONS::DVMPObservableKinematic::operator==

(

const DVMPObservableKinematic &

other

)

const

Is equal operator.

Checks if values of kinematic variables are the same.

serialize()

void PARTONS::DVMPObservableKinematic::serialize

(

ElemUtils::Packet &

packet

)

const

Serialize into given Packet.

Parameters

packet

Target Packet.

serializeIntoStdVector()

void PARTONS::DVMPObservableKinematic::serializeIntoStdVector

(

std::vector< double > &

vec

)

const

Serialize to std::vector<double>.

setE() [1/2]

void PARTONS::DVMPObservableKinematic::setE

(

const PhysicalType< double > &

E

)

Set beam energy.

setE() [2/2]

void PARTONS::DVMPObservableKinematic::setE	(	double	E,
		PhysicalUnit::Type	unit = PhysicalUnit::GEV
	)

Set beam energy.

setMesonType()

void PARTONS::DVMPObservableKinematic::setMesonType

(

MesonType::Type

mesonType

)

Set meson type.

setPhi() [1/2]

void PARTONS::DVMPObservableKinematic::setPhi

(

const PhysicalType< double > &

phi

)

Set angle between leptonic and hadronic planes (in radians).

setPhi() [2/2]

void PARTONS::DVMPObservableKinematic::setPhi	(	double	phi,
		PhysicalUnit::Type	unit = PhysicalUnit::RAD
	)

Set angle between leptonic and hadronic planes (in radians).

setQ2() [1/2]

void PARTONS::DVMPObservableKinematic::setQ2

(

const PhysicalType< double > &

Q2

)

Set virtual-photon virtuality.

setQ2() [2/2]

void PARTONS::DVMPObservableKinematic::setQ2	(	double	Q2,
		PhysicalUnit::Type	unit = PhysicalUnit::GEV2
	)

Set virtual-photon virtuality.

setT() [1/2]

void PARTONS::DVMPObservableKinematic::setT

(

const PhysicalType< double > &

t

)

Set four-momentum transfer squared of hadron target.

setT() [2/2]

void PARTONS::DVMPObservableKinematic::setT	(	double	t,
		PhysicalUnit::Type	unit = PhysicalUnit::GEV2
	)

Set four-momentum transfer squared of hadron target.

setXB() [1/2]

void PARTONS::DVMPObservableKinematic::setXB

(

const PhysicalType< double > &

xB

)

Set Bjorken variable.

setXB() [2/2]

void PARTONS::DVMPObservableKinematic::setXB	(	double	xB,
		PhysicalUnit::Type	unit = PhysicalUnit::NONE
	)

Set Bjorken variable.

toString()

std::string PARTONS::DVMPObservableKinematic::toString ( ) const

virtual

Return a pre-formatted characters string for output visualization of class member's values.

Returns

a pre-formatted characters string.

Reimplemented from PARTONS::ObservableKinematic.

unserialize()

void PARTONS::DVMPObservableKinematic::unserialize

(

ElemUtils::Packet &

packet

)

Retrieve data from given Packet.

Parameters

packet

Input Packet.

unserializeFromStdVector()

void PARTONS::DVMPObservableKinematic::unserializeFromStdVector	(	std::vector< double >::const_iterator &	it,
		const std::vector< double >::const_iterator &	end
	)

Unserialize from std::vector<double>.

updateHashSum()

void PARTONS::DVMPObservableKinematic::updateHashSum ( ) const

protectedvirtual

Update hash sum (see Kinematic::m_hashSum variable).

Implements PARTONS::ObservableKinematic.

Member Data Documentation

DVMP_OBSERVABLE_KNEMATIC_CLASS_NAME

const std::string PARTONS::DVMPObservableKinematic::DVMP_OBSERVABLE_KNEMATIC_CLASS_NAME

static

Initial value:

=
        "DVMPObservableKinematic"

Type of the kinematic in XML automation.

KINEMATIC_PARAMETER_NAME_BEAM_ENERGY

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_BEAM_ENERGY

static

Initial value:

=
        "E"

Parameter name to set variable \(E_{b}\) via configuration methods.

KINEMATIC_PARAMETER_NAME_BEAM_ENERGY_UNIT

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_BEAM_ENERGY_UNIT

static

Initial value:

=
        "E_unit"

Parameter name to set unit of variable \(E_{b}\) via configuration methods.

KINEMATIC_PARAMETER_NAME_MESON_TYPE

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_MESON_TYPE

static

Initial value:

=
        "meson"

Parameter name to set meson type via configuration methods.

KINEMATIC_PARAMETER_NAME_MESON_TYPE_UNIT

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_MESON_TYPE_UNIT

static

Initial value:

=
        "meson_unit"

Parameter name to set unit of meson type via configuration methods.

KINEMATIC_PARAMETER_NAME_PHI

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_PHI = "phi"

static

Parameter name to set variable \(\phi\) via configuration methods.

KINEMATIC_PARAMETER_NAME_PHI_UNIT

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_PHI_UNIT

static

Initial value:

=
        "phi_unit"

Parameter name to set unit of variable \(\phi\) via configuration methods.

KINEMATIC_PARAMETER_NAME_Q2

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_Q2 = "Q2"

static

Parameter name to set variable \(Q^{2}\) via configuration methods.

KINEMATIC_PARAMETER_NAME_Q2_UNIT

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_Q2_UNIT

static

Initial value:

=
        "Q2_unit"

Parameter name to set unit of variable \(Q^{2}\) via configuration methods.

KINEMATIC_PARAMETER_NAME_XB

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_XB = "xB"

static

Parameter name to set variable \(x_{B}\) via configuration methods.

KINEMATIC_PARAMETER_NAME_XB_UNIT

const std::string PARTONS::DVMPObservableKinematic::KINEMATIC_PARAMETER_NAME_XB_UNIT

static

Initial value:

=
        "xB_unit"

Parameter name to set unit of variable \(x_{B}\) via configuration methods.

m_E

PhysicalType<double> PARTONS::DVMPObservableKinematic::m_E

private

Beam energy (in GeV).

m_mesonType

MesonType::Type PARTONS::DVMPObservableKinematic::m_mesonType

private

Meson type.

m_phi

PhysicalType<double> PARTONS::DVMPObservableKinematic::m_phi

private

Angle between leptonic and hadronic planes (in radians, Trento convention).

m_Q2

PhysicalType<double> PARTONS::DVMPObservableKinematic::m_Q2

private

Virtual-photon virtuality (in \(GeV^{2}\)).

m_t

PhysicalType<double> PARTONS::DVMPObservableKinematic::m_t

private

Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).

m_xB

PhysicalType<double> PARTONS::DVMPObservableKinematic::m_xB

private

Bjorken variable.

---

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

• include/partons/beans/observable/DVMP/DVMPObservableKinematic.h
• src/partons/beans/observable/DVMP/DVMPObservableKinematic.cpp