Abstract class representing single observable kinematics. More...

Inheritance diagram for PARTONS::ObservableKinematic:

Public Member Functions
virtual	~ObservableKinematic ()
	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...

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)

Protected Member Functions
	ObservableKinematic (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...

	ObservableKinematic (const ObservableKinematic &other)
	Copy constructor. More...

virtual void	updateHashSum () const =0
	Update hash sum (see Kinematic::m_hashSum variable). 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...

Detailed Description

Abstract class representing single observable kinematics.

This class represents a single observable kinematics (none).

Constructor & Destructor Documentation

◆ ~ObservableKinematic()

PARTONS::ObservableKinematic::~ObservableKinematic ( )

virtual

Destructor.

◆ ObservableKinematic() [1/2]

PARTONS::ObservableKinematic::ObservableKinematic	(	const std::string &	className,
		ChannelType::Type	channelType
	)

protected

Default constructor.

◆ ObservableKinematic() [2/2]

PARTONS::ObservableKinematic::ObservableKinematic ( const ObservableKinematic & other )

protected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ configure()

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

virtual

Configure via parameters.

Parameters

parameters Set of parameters to be set.

Reimplemented from PARTONS::Kinematic.

Reimplemented in PARTONS::TCSObservableKinematic, PARTONS::GAM2ObservableKinematic, PARTONS::DVMPObservableKinematic, PARTONS::DVCSObservableKinematic, and PARTONS::DDVCSObservableKinematic.

◆ serialize()

void PARTONS::ObservableKinematic::serialize ( ElemUtils::Packet & packet ) const

Serialize into given Packet.

Parameters

packet Target Packet.

◆ serializeIntoStdVector()

void PARTONS::ObservableKinematic::serializeIntoStdVector ( std::vector< double > & vec ) const

Serialize to std::vector<double>.

◆ toString()

std::string PARTONS::ObservableKinematic::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::Kinematic.

Reimplemented in PARTONS::TCSObservableKinematic, PARTONS::GAM2ObservableKinematic, PARTONS::DVMPObservableKinematic, PARTONS::DVCSObservableKinematic, and PARTONS::DDVCSObservableKinematic.

◆ unserialize()

void PARTONS::ObservableKinematic::unserialize ( ElemUtils::Packet & packet )

Retrieve data from given Packet.

Parameters

packet Input Packet.

◆ unserializeFromStdVector()

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

Unserialize from std::vector<double>.

◆ updateHashSum()

virtual void PARTONS::ObservableKinematic::updateHashSum ( ) const

protectedpure virtual

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

Implements PARTONS::Kinematic.

Implemented in PARTONS::TCSObservableKinematic, PARTONS::GAM2ObservableKinematic, PARTONS::DVMPObservableKinematic, PARTONS::DVCSObservableKinematic, and PARTONS::DDVCSObservableKinematic.

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

include/partons/beans/observable/ObservableKinematic.h
src/partons/beans/observable/ObservableKinematic.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ObservableKinematic()

◆ ObservableKinematic() [1/2]

◆ ObservableKinematic() [2/2]

Member Function Documentation

◆ configure()

◆ serialize()

◆ serializeIntoStdVector()

◆ toString()

◆ unserialize()

◆ unserializeFromStdVector()

◆ updateHashSum()