UtilRunner Class Reference

Inheritance diagram for UtilRunner:

Public Slots
void	request_cancel ()
	request_cancel send a cancel request to the worker to exit early

Signals
void	init_complete ()
	Publish that the worker has finished its initialization.
void	result (int ret_val)
	Notify when the worker execution has finished. More...

Public Member Functions
	UtilRunner (QString cmd, UtilWorker *util_worker, LogEmitter *err_emitter)
	Constructor. More...
QString	command ()
	Accessor method for the command associated with this worker. More...
bool	is_hidden ()
	Determine if the utility shall be hidden or shown based on current state. More...
QWidget *	worker_widget ()
bool	has_widget ()
QString	worker_widget_type ()
	worker_widget_type gets the type of widget from the plugin More...

Protected Member Functions
void	run ()
	Perform time-consuming task in a background thread when the thread pool queues it.

Protected Attributes
QString	command_str
UtilWorker *	worker
SignalCounter	err_flag
SignalCounter	warn_flag
int	result_code

Constructor & Destructor Documentation

UtilRunner::UtilRunner	(	QString	cmd,
		UtilWorker *	util_worker,
		LogEmitter *	err_emitter
	)

Constructor.

Parameters

cmd	QString associated with the worker
util_worker	UtilWorker implements the utility business logic for the given command
err_emitter	LogEmitter used to monitor the qDebug log levels

Member Function Documentation

QString UtilRunner::command

(

)

Accessor method for the command associated with this worker.

Returns

QString command

bool UtilRunner::is_hidden

(

)

Determine if the utility shall be hidden or shown based on current state.

Returns

bool True if the utilility shall be hidden, False otherwise

void UtilRunner::result ( int  ret_val )

signal

Notify when the worker execution has finished.

Parameters

ret_val

int Return value code

QString UtilRunner::worker_widget_type

(

)

worker_widget_type gets the type of widget from the plugin

Returns

QString type of widget the plugin uses

---

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

• lib/include/util_runner.h
• lib/src/util_runner.cpp