PARTONS::ScenarioDao Class Reference

Scenario information Data Access Object (DAO). More...

Inheritance diagram for PARTONS::ScenarioDao:

Public Member Functions
	ScenarioDao ()
	Default constructor. More...
virtual	~ScenarioDao ()
	Destructor. More...
int	insertWithoutTransaction (const std::string &description, const std::string &xmlFile, const std::string &hashSum) const
	Insert scenario information into the database. More...
int	getScenarioIdByHashSum (const std::string &hashSum) const
	Retrieve unique id of row containing scenario information in the database by given hash sum. More...
std::string	getXMLFileByIndexId (const int indexId) const
	Retrieve xml file scenario representation by given unique id of computation. More...
int	getScenarioIdByComputationId (const int computationId) const
	Retrieve unique id of row containing scenario information in the database by id of that containing computation information. More...
std::string	getHashSumById (const int scenarioId)
	Retrieve hash sum associated to scenario information stored in row in the database of unique id. More...
Scenario *	getScenarioById (const int scenarioId)
	Try to find an entry in the database containing scenario information that matches with given unique id value. More...
void	updateScenarioFile (const int scenarioId, const std::string &file, const std::string &hashSum)
	Update row containing scenario information in the database. 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...
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)

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

Scenario information Data Access Object (DAO).

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

Constructor & Destructor Documentation

ScenarioDao()

PARTONS::ScenarioDao::ScenarioDao

(

)

Default constructor.

~ScenarioDao()

PARTONS::ScenarioDao::~ScenarioDao ( )

virtual

Destructor.

Member Function Documentation

getHashSumById()

std::string PARTONS::ScenarioDao::getHashSumById

(

const int

scenarioId

)

Retrieve hash sum associated to scenario information stored in row in the database of unique id.

Parameters

scenarioId

Unique id of row containing scenario information in the database.

Returns

Associated hash sum.

getScenarioById()

Scenario * PARTONS::ScenarioDao::getScenarioById

(

const int

scenarioId

)

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

Parameters

scenarioId

Unique id of database entry to be found.

Returns

Pointer to Scenario object filled with the retrieved data or null pointer if couldn't find it. If successful, Scenario object is automatically registered in ResourceManager.

getScenarioIdByComputationId()

int PARTONS::ScenarioDao::getScenarioIdByComputationId

(

const int

computationId

)

const

Retrieve unique id of row containing scenario information in the database by id of that containing computation information.

Parameters

computationId

Unique id of row containing scenario information in the database.

Returns

Unique id of selected row in the database.

getScenarioIdByHashSum()

int PARTONS::ScenarioDao::getScenarioIdByHashSum

(

const std::string &

hashSum

)

const

Retrieve unique id of row containing scenario information in the database by given hash sum.

Parameters

hashSum

Hash sum of scenario information to be selected.

Returns

Unique id of selected row in the database.

getXMLFileByIndexId()

std::string PARTONS::ScenarioDao::getXMLFileByIndexId

(

const int

indexId

)

const

Retrieve xml file scenario representation by given unique id of computation.

Parameters

indexId

Unique id of row containing scenario information to be selected.

Returns

String containing xml representation.

insertWithoutTransaction()

int PARTONS::ScenarioDao::insertWithoutTransaction	(	const std::string &	description,
		const std::string &	xmlFile,
		const std::string &	hashSum
	)		const

Insert scenario information into the database.

Parameters

description	Scenario description.
xmlFile	Xml file scenario representation.
hashSum	Hash sum of xml file.

Returns

Unique id of inserted row in the database.

updateScenarioFile()

void PARTONS::ScenarioDao::updateScenarioFile	(	const int	scenarioId,
		const std::string &	file,
		const std::string &	hashSum
	)

Update row containing scenario information in the database.

Parameters

scenarioId	Unique id of scenario information to be selected.
file	Xml file scenario representation.
hashSum	Hash sum of xml file.

---

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

• include/partons/database/common/dao/ScenarioDao.h
• src/partons/database/common/dao/ScenarioDao.cpp