PARTONS::Kinematic Class Reference

Base class for all kinematic-like classes. More...

Inheritance diagram for PARTONS::Kinematic:

Public Member Functions
virtual	~Kinematic ()
	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...
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
	Kinematic (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...
	Kinematic (const Kinematic &other)
	Copy constructor. More...
virtual void	updateHashSum () const =0
	Update hash sum (see Kinematic::m_hashSum variable). 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
ChannelType::Type	m_channelType
	Channel type. More...
std::string	m_hashSum
	Hash sum of class content. More...

Detailed Description

Base class for all kinematic-like classes.

This class is used as a base (abstract) class for all classes storing kinematics information, like e.g. GPDKinematic or ObservableKinematic.

Constructor & Destructor Documentation

~Kinematic()

PARTONS::Kinematic::~Kinematic ( )

virtual

Destructor.

Kinematic() [1/2]

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

protected

Default constructor.

Parameters

className

Name of class to be associated to BaseObject (see BaseObject::m_className variable)

Kinematic() [2/2]

PARTONS::Kinematic::Kinematic ( const Kinematic &  other )

protected

Copy constructor.

Parameters

other

Object to be copied.

Member Function Documentation

configure()

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

virtual

Configure via parameters.

Parameters

parameters

Set of parameters to be set.

Reimplemented in PARTONS::TCSObservableKinematic, PARTONS::ObservableKinematic, PARTONS::GAM2ObservableKinematic, PARTONS::DVMPObservableKinematic, PARTONS::DVCSObservableKinematic, PARTONS::DDVCSObservableKinematic, PARTONS::GPDSubtractionConstantKinematic, PARTONS::GPDKinematic, PARTONS::TCSConvolCoeffFunctionKinematic, PARTONS::GAM2ConvolCoeffFunctionKinematic, PARTONS::DVMPConvolCoeffFunctionKinematic, PARTONS::DVCSConvolCoeffFunctionKinematic, PARTONS::DDVCSConvolCoeffFunctionKinematic, PARTONS::ConvolCoeffFunctionKinematic, and PARTONS::CollinearDistributionKinematic.

getChannelType()

ChannelType::Type PARTONS::Kinematic::getChannelType

(

)

const

Get channel type.

getHashSum()

const std::string & PARTONS::Kinematic::getHashSum

(

)

const

Get hash sum of class content.

serialize()

void PARTONS::Kinematic::serialize

(

ElemUtils::Packet &

packet

)

const

Serialize into given Packet.

Parameters

packet

Target Packet.

serializeIntoStdVector()

void PARTONS::Kinematic::serializeIntoStdVector

(

std::vector< double > &

vec

)

const

Serialize to std::vector<double>.

setHashSum()

void PARTONS::Kinematic::setHashSum

(

const std::string &

hashSum

)

const

Set hash sum of class content.

Parameters

hashSum

toString()

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

Reimplemented in PARTONS::TCSObservableKinematic, PARTONS::ObservableKinematic, PARTONS::GAM2ObservableKinematic, PARTONS::DVMPObservableKinematic, PARTONS::DVCSObservableKinematic, PARTONS::DDVCSObservableKinematic, PARTONS::GPDSubtractionConstantKinematic, PARTONS::GPDKinematic, PARTONS::TCSConvolCoeffFunctionKinematic, PARTONS::GAM2ConvolCoeffFunctionKinematic, PARTONS::DVMPConvolCoeffFunctionKinematic, PARTONS::DVCSConvolCoeffFunctionKinematic, PARTONS::DDVCSConvolCoeffFunctionKinematic, PARTONS::ConvolCoeffFunctionKinematic, and PARTONS::CollinearDistributionKinematic.

unserialize()

void PARTONS::Kinematic::unserialize

(

ElemUtils::Packet &

packet

)

Retrieve data from given Packet.

Parameters

packet

Input Packet.

unserializeFromStdVector()

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

Unserialize from std::vector<double>.

updateHashSum()

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

protectedpure virtual

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

Implemented in PARTONS::ObservableKinematic, PARTONS::ConvolCoeffFunctionKinematic, PARTONS::TCSObservableKinematic, PARTONS::GAM2ObservableKinematic, PARTONS::DVMPObservableKinematic, PARTONS::DVCSObservableKinematic, PARTONS::DDVCSObservableKinematic, PARTONS::GPDSubtractionConstantKinematic, PARTONS::GPDKinematic, PARTONS::TCSConvolCoeffFunctionKinematic, PARTONS::GAM2ConvolCoeffFunctionKinematic, PARTONS::DVMPConvolCoeffFunctionKinematic, PARTONS::DVCSConvolCoeffFunctionKinematic, PARTONS::DDVCSConvolCoeffFunctionKinematic, and PARTONS::CollinearDistributionKinematic.

Member Data Documentation

m_channelType

ChannelType::Type PARTONS::Kinematic::m_channelType

private

Channel type.

m_hashSum

std::string PARTONS::Kinematic::m_hashSum

mutableprivate

Hash sum of class content.

---

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

• include/partons/beans/Kinematic.h
• src/partons/beans/Kinematic.cpp