PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
PARTONS::TCSAutSinPhiMPhis Class Reference

Asymmetry probing transverse target polarization \(\sin(\phi - \phi_{S})\) component. More...

Inheritance diagram for PARTONS::TCSAutSinPhiMPhis:
PARTONS::TCSObservable PARTONS::Observable< TCSObservableKinematic, TCSObservableResult > PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

 TCSAutSinPhiMPhis (const std::string &className)
 Constructor. More...
 
virtual ~TCSAutSinPhiMPhis ()
 Destructor. More...
 
virtual TCSAutSinPhiMPhisclone () const
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
 
- Public Member Functions inherited from PARTONS::TCSObservable
virtual ~TCSObservable ()
 Destructor. More...
 
virtual std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. 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...
 
virtual void run ()
 
virtual void configure (const ElemUtils::Parameters &parameters)
 Provides a generic method to configure all types of modules by passing a Parameters object. More...
 
virtual void prepareSubModules (const std::map< std::string, BaseObjectData > &subModulesData)
 Method used in automation to prepare all the modules used by this current module and configure them recursively. More...
 
virtual TCSObservableResult compute (const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 Computes the observable at given kinematics. More...
 
virtual List< GPDTypegetListOfAvailableGPDTypeForComputation () const
 Must be implemented in child class. More...
 
TCSProcessModulegetProcessModule () const
 Get process module. More...
 
void setProcessModule (TCSProcessModule *pProcessModule)
 Set process module. More...
 
- Public Member Functions inherited from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >
virtual ~Observable ()
 Destructor. More...
 
- Public Member Functions inherited from PARTONS::ModuleObject
 ModuleObject (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
virtual ~ModuleObject ()
 Default destructor. More...
 
unsigned int getReferenceModuleId () const
 Get reference module id. More...
 
void setReferenceModuleId (unsigned int referenceModuleId)
 Set reference module id. More...
 
ChannelType::Type getChannelType () const
 Get channel type. More...
 
- Public Member Functions inherited from PARTONS::BaseObject
 BaseObject (const std::string &className)
 Constructor. More...
 
virtual ~BaseObject ()
 Default destructor. 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 unsigned int classId
 Unique ID to automatically register the class in the registry. More...
 
- Static Public Attributes inherited from PARTONS::TCSObservable
static const std::string TCS_OBSERVABLE_MODULE_CLASS_NAME
 Type of the module in XML automation. More...
 
- Static Public Attributes inherited from PARTONS::ModuleObject
static const std::string CLASS_NAME = "className"
 

Protected Member Functions

 TCSAutSinPhiMPhis (const TCSAutSinPhiMPhis &other)
 Copy constructor. More...
 
virtual PhysicalType< double > computeObservable (const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType)
 Evaluate observable. More...
 
- Protected Member Functions inherited from PARTONS::TCSObservable
 TCSObservable (const std::string &className)
 Default constructor. More...
 
 TCSObservable (const TCSObservable &other)
 Copy constructor. More...
 
virtual void initModule ()
 Pure virtual function that provides skeleton for module initialization. More...
 
virtual void isModuleWellConfigured ()
 Pure virtual function that provides skeleton to check if the module is well initialized and configured. More...
 
- Protected Member Functions inherited from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >
 Observable (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
 Observable (const Observable &other)
 Copy constructor. More...
 
std::vector< double > serializeKinematicsAndGPDTypesIntoStdVector (const TCSObservableKinematic &kin, const List< GPDType > &list) const
 Serialize kinematics and list of GPD types to std::vector<double>. More...
 
void unserializeKinematicsAndGPDTypesFromStdVector (const std::vector< double > &vec, TCSObservableKinematic &kin, List< GPDType > &list) const
 Unserialize kinematics and list of GPD types from std::vector<double>. More...
 
- Protected Member Functions inherited from PARTONS::ModuleObject
 ModuleObject (const ModuleObject &other)
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from PARTONS::TCSObservable
TCSProcessModulem_pProcessModule
 Pointer to the underlying process module. More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

Asymmetry probing transverse target polarization \(\sin(\phi - \phi_{S})\) component.

Unit: none.

Constructor & Destructor Documentation

◆ TCSAutSinPhiMPhis() [1/2]

PARTONS::TCSAutSinPhiMPhis::TCSAutSinPhiMPhis ( const std::string &  className)

Constructor.

Parameters
classNameName of class.

◆ ~TCSAutSinPhiMPhis()

PARTONS::TCSAutSinPhiMPhis::~TCSAutSinPhiMPhis ( )
virtual

Destructor.

◆ TCSAutSinPhiMPhis() [2/2]

PARTONS::TCSAutSinPhiMPhis::TCSAutSinPhiMPhis ( const TCSAutSinPhiMPhis other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

TCSAutSinPhiMPhis * PARTONS::TCSAutSinPhiMPhis::clone ( ) const
virtual

Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry.

Returns

Implements PARTONS::TCSObservable.

◆ computeObservable()

PhysicalType< double > PARTONS::TCSAutSinPhiMPhis::computeObservable ( const TCSObservableKinematic kinematic,
const List< GPDType > &  gpdType 
)
protectedvirtual

Evaluate observable.

To be implemented in a child class.

Implements PARTONS::TCSObservable.

Member Data Documentation

◆ classId

const unsigned int PARTONS::TCSAutSinPhiMPhis::classId
static
Initial value:
=
new TCSAutSinPhiMPhis("TCSAutSinPhiMPhis"))
unsigned int registerBaseObject(BaseObject *pBaseObject)
Store a unique instance of a module identified by a unique string character key.
Definition: BaseObjectRegistry.cpp:45
static BaseObjectRegistry * getInstance()
Static function to be able to retrieve a unique instance pointer of this class anywhere in the code.
Definition: BaseObjectRegistry.cpp:15
TCSAutSinPhiMPhis(const std::string &className)
Constructor.
Definition: TCSAutSinPhiMPhis.cpp:16

Unique ID to automatically register the class in the registry.


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