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

Class storing environment configuration information. More...

Inheritance diagram for PARTONS::EnvironmentConfiguration:
PARTONS::DatabaseFileObject PARTONS::BaseObject

Public Member Functions

 EnvironmentConfiguration ()
 Default constructor. More...
 
 EnvironmentConfiguration (int indexId, time_t storeDate, const std::string &configuration, const std::string &hashSum)
 Assignment constructor. More...
 
virtual ~EnvironmentConfiguration ()
 Destructor. More...
 
- Public Member Functions inherited from PARTONS::DatabaseFileObject
 DatabaseFileObject (const std::string &className)
 Constructor. More...
 
 DatabaseFileObject (const std::string &className, const int indexId, const time_t storeDate, const std::string &filePath, const std::string &hashSum, const std::string &file)
 Constructor. More...
 
 DatabaseFileObject (const DatabaseFileObject &other)
 Copy constructor. More...
 
virtual ~DatabaseFileObject ()
 Destructor. More...
 
virtual std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. More...
 
const std::string & getFile () const
 Get reference to DatabaseFileObject::m_file. More...
 
void setFile (const std::string &file)
 Set DatabaseFileObject::m_file. More...
 
const std::string & getHashSum () const
 Get reference to DatabaseFileObject::m_hashSum. More...
 
void setHashSum (const std::string &hashSum)
 Set DatabaseFileObject::m_hashSum. More...
 
time_t getStoreDate () const
 Get DatabaseFileObject::m_storeDate. More...
 
void setStoreDate (time_t storeDate)
 Set DatabaseFileObject::m_storeDate. More...
 
const std::string & getFilePath () const
 Get reference to DatabaseFileObject::m_filePath. More...
 
void setFilePath (const std::string &filePath)
 Set DatabaseFileObject::m_filePath. More...
 
- Public Member Functions inherited from PARTONS::BaseObject
 BaseObject (const std::string &className)
 Constructor. More...
 
virtual ~BaseObject ()
 Default destructor. More...
 
virtual BaseObjectclone () 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

virtual std::string fillFile () const
 Fill file from database. 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

Class storing environment configuration information.

This class is used to store the environment configuration information. Such information can be set via a text file indicated by environment.configuration.file.path property in the main configuration file of PARTONS, namely partons.properties. It may look like that:

Linux partons 3.2.0-4-amd64 #1 SMP Debian 3.2.73-2+deb7u2 x86_64 GNU/Linux
g++ (Debian 4.7.2-5) 4.7.2
GSL 1.16
ROOT 5.34.32
CLN 1.3.4
SFML 2.3.2
QT 4.8.3
PARTONS Revision: 728
NumA++ Revision: 728
Definition: DVCSCFFDispersionRelation.h:20
Definition: BaseObject.cpp:11

When a computation is done via xml scenario and its result is stored in the database, the environment configuration information is associated to it. This allows to check the environment configuration information for any result stored in the database.

Constructor & Destructor Documentation

◆ EnvironmentConfiguration() [1/2]

PARTONS::EnvironmentConfiguration::EnvironmentConfiguration ( )

Default constructor.

◆ EnvironmentConfiguration() [2/2]

PARTONS::EnvironmentConfiguration::EnvironmentConfiguration ( int  indexId,
time_t  storeDate,
const std::string &  configuration,
const std::string &  hashSum 
)

Assignment constructor.

Parameters
indexIdUnique id used when object is created from the database, see BaseObject::m_indexId.
storeDateTime of insertion into the database.
configurationString storing the configuration file.
hashSumHash sum of file content.

◆ ~EnvironmentConfiguration()

PARTONS::EnvironmentConfiguration::~EnvironmentConfiguration ( )
virtual

Destructor.

Member Function Documentation

◆ fillFile()

std::string PARTONS::EnvironmentConfiguration::fillFile ( ) const
protectedvirtual

Fill file from database.

Returns
String containing file.

Implements PARTONS::DatabaseFileObject.


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