hds::BatchModuleContext Class Reference

#include <hds_batch_module_context.hpp>

Public Member Functions
	BatchModuleContext ()
	BatchModuleContext (const hds::BatchModuleContext &obj)
void	operator= (const hds::BatchModuleContext &obj)
const QString &	name () const
void	setName (const QString &name)
const QString &	comment () const
void	setComment (const QString &comment)
const QDateTime &	dateTime () const
void	setDateTime (const QDateTime &dt)
const QString &	author () const
void	setAuthor (const QString &author)
const QWidget *	widget () const
void	setWidget (QWidget *wid)
const QWidget *	parentWidget () const
void	setParentWidget (QWidget *wid)
const hds::BatchModuleParameter &	parameter (const QString &name) const
bool	checkParameter (const QString &name) const
void	addParameter (const QString &name, const hds::BatchModuleParameter &param)
void	removeParameters ()
const QMap< QString, hds::BatchModuleParameter * > &	parameters () const
void	info () const

Protected Attributes
QWidget *	m_pParentWidget
QWidget *	m_pModuleWidget
QMap< QString, hds::BatchModuleParameter * >	m_parameters
QString	m_module_name
QString	m_comment
QDateTime	m_dt
QString	m_author

Detailed Description

Batch module execution context.

Constructor & Destructor Documentation

hds::BatchModuleContext::BatchModuleContext

(

)

Default constructor, parent and module widget pointers is 0x0

hds::BatchModuleContext::BatchModuleContext

(

const hds::BatchModuleContext &

obj

)

Copy constructor.

Member Function Documentation

void hds::BatchModuleContext::addParameter	(	const QString &	name,
		const hds::BatchModuleParameter &	param
	)

Add new parameter with its name. Replace parameter's value if

one presents with the same name.

const QString& hds::BatchModuleContext::author

(

)

const

Get author of the module

bool hds::BatchModuleContext::checkParameter

(

const QString &

name

)

const

Returns true if parameter with provided name presents.

const QString& hds::BatchModuleContext::comment

(

)

const

Get comment of the module

const QDateTime& hds::BatchModuleContext::dateTime

(

)

const

Get creation date and time of the module

void hds::BatchModuleContext::info

(

)

const

Prints context info.

const QString& hds::BatchModuleContext::name

(

)

const

Get name of the module.

void hds::BatchModuleContext::operator=

(

const hds::BatchModuleContext &

obj

)

Copy an object.

const hds::BatchModuleParameter& hds::BatchModuleContext::parameter

(

const QString &

name

)

const

Get reference to parameter by its name. If the parameter with provided

name absents then return parameter of undefined type.

const QMap<QString, hds::BatchModuleParameter*>& hds::BatchModuleContext::parameters ( ) const

inline

Get map of the parameters.

const QWidget* hds::BatchModuleContext::parentWidget

(

)

const

Get the parent interface widget.

void hds::BatchModuleContext::removeParameters

(

)

Remove all parameters.

void hds::BatchModuleContext::setAuthor

(

const QString &

author

)

Set author of the module

void hds::BatchModuleContext::setComment

(

const QString &

comment

)

Set comment of the module

void hds::BatchModuleContext::setDateTime

(

const QDateTime &

dt

)

Set creation data and time of the module

void hds::BatchModuleContext::setName

(

const QString &

name

)

Set name of the module.

void hds::BatchModuleContext::setParentWidget

(

QWidget *

wid

)

Set the parent interface widget.

void hds::BatchModuleContext::setWidget

(

QWidget *

wid

)

Set the module interface widget.

const QWidget* hds::BatchModuleContext::widget

(

)

const

Get the module interface widget.

Member Data Documentation

QString hds::BatchModuleContext::m_comment

protected

Date and time of module creation.

QDateTime hds::BatchModuleContext::m_dt

protected

Author of the module.

QString hds::BatchModuleContext::m_module_name

protected

Comment of the module.

QMap<QString, hds::BatchModuleParameter*> hds::BatchModuleContext::m_parameters

protected

Name of the module.

QWidget* hds::BatchModuleContext::m_pModuleWidget

protected

Parameters of the module.

QWidget* hds::BatchModuleContext::m_pParentWidget

protected

< Parent interface widget. Module interface widget.

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/hds_batch/hds_batch_module_context.hpp