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

Environment configuration Data Access Object (DAO). More...

Inheritance diagram for PARTONS::EnvironmentConfigurationDao:
PARTONS::BaseObject

Public Member Functions

 EnvironmentConfigurationDao ()
 Default constructor. More...
 
virtual ~EnvironmentConfigurationDao ()
 Destructor. More...
 
int insert (const time_t &storeDate, const std::string &configuration, const std::string &md5) const
 Insert environment configuration into the database. More...
 
EnvironmentConfigurationselectByIndexId (const int indexId) const
 Try to find an entry in the database containing environment configuration that matches with given unique id value. More...
 
int getEnvironmentConfigurationIdByHashSum (const std::string &md5) const
 Retrieve unique id of row containing environment configuration in the database by given hash sum. More...
 
std::string getConfigurationByIndexId (const int indexId) const
 Retrieve environment configuration by given unique id. 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...
 
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
 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)
 

Private Member Functions

EnvironmentConfigurationgetEnvironmentConfigurationFromQuery (QSqlQuery &query) const
 Get EnvironmentConfiguration object from given query. More...
 

Additional Inherited Members

- 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

Environment configuration Data Access Object (DAO).

This DAO is used to insert, select and delete environment configurations from the database. This class in not intended to be used by regular users who should deal with EnvironmentConfigurationDaoService instead.

Constructor & Destructor Documentation

◆ EnvironmentConfigurationDao()

PARTONS::EnvironmentConfigurationDao::EnvironmentConfigurationDao ( )

Default constructor.

◆ ~EnvironmentConfigurationDao()

PARTONS::EnvironmentConfigurationDao::~EnvironmentConfigurationDao ( )
virtual

Destructor.

Member Function Documentation

◆ getConfigurationByIndexId()

std::string PARTONS::EnvironmentConfigurationDao::getConfigurationByIndexId ( const int  indexId) const

Retrieve environment configuration by given unique id.

Parameters
indexIdUnique id of row containing environment configuration to be selected.
Returns
String containing environment configuration.

◆ getEnvironmentConfigurationFromQuery()

EnvironmentConfiguration * PARTONS::EnvironmentConfigurationDao::getEnvironmentConfigurationFromQuery ( QSqlQuery &  query) const
private

Get EnvironmentConfiguration object from given query.

Parameters
queryInput QSqlQuery query.
Returns
Pointer to extracted EnvironmentConfiguration object.

◆ getEnvironmentConfigurationIdByHashSum()

int PARTONS::EnvironmentConfigurationDao::getEnvironmentConfigurationIdByHashSum ( const std::string &  md5) const

Retrieve unique id of row containing environment configuration in the database by given hash sum.

Parameters
md5Hash sum of environment configuration to be selected.
Returns
Unique id of database entry that matches with hash sum value.

◆ insert()

int PARTONS::EnvironmentConfigurationDao::insert ( const time_t &  storeDate,
const std::string &  configuration,
const std::string &  md5 
) const

Insert environment configuration into the database.

Parameters
storeDateInsertion time.
configurationEnvironment configuration to be stored.
md5Hash sum of environment configuration.
Returns
Unique id of inserted row in the database.

◆ selectByIndexId()

EnvironmentConfiguration * PARTONS::EnvironmentConfigurationDao::selectByIndexId ( const int  indexId) const

Try to find an entry in the database containing environment configuration that matches with given unique id value.

Parameters
indexIdUnique id of database entry to be found.
Returns
Pointer to EnvironmentConfiguration object filled with the retrieved data or null pointer if couldn't find it.

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