Workspace 6.21.5
Signals | Public Member Functions | List of all members
ExecutionAction Class Reference

QAction subclass for handling execution of a Workspace.

#include <Workspace/Presentation/executionaction.h>

Inherits QAction.

Signals

void executionStateChange (bool isRunning)
 
void updateAborted (bool abnormal, double elapsedTime)
 
void updateFinished (double elapsedTime)
 
void updateStarted ()
 

Public Member Functions

 ExecutionAction (DataExecution::Workspace &workspace, QObject *parent=nullptr)
 
 ~ExecutionAction () override
 
DataExecution::WorkspacegetWorkspace ()
 
void setWorkspace (DataExecution::Workspace &workspace)
 

Constructor & Destructor Documentation

◆ ExecutionAction()

ExecutionAction ( DataExecution::Workspace workspace,
QObject *  parent = nullptr 
)

◆ ~ExecutionAction()

~ExecutionAction ( )
override

Member Function Documentation

◆ executionStateChange

void executionStateChange ( bool  isRunning)
signal
Parameters
isRunningIf true, the execution thread has started, and if false the thread has stopped execution.

◆ getWorkspace()

DataExecution::Workspace & getWorkspace ( )
Returns
The workspace this action is associated with.
See also
setWorkspace()

◆ setWorkspace()

void setWorkspace ( DataExecution::Workspace workspace)
Parameters
workspaceThe workspace to associate with this action.

The previous workspace association of this action is discarded. The previous workspace itself is unaffected apart from the removal of some observers.

See also
getWorkspace()

◆ updateAborted

void updateAborted ( bool  abnormal,
double  elapsedTime 
)
signal
Parameters
abnormalIf true, the update aborted as a result of an error during execution. If false, the workspace was asked to terminate execution, presumably by the user unchecking this action object.
elapsedTimeThe elapsed time in seconds since the last updateStarted() signal.
See also
updateStarted(), updateFinished()

◆ updateFinished

void updateFinished ( double  elapsedTime)
signal
Parameters
elapsedTimeThe elapsed time in seconds since the last updateStarted() signal.
See also
updateStarted(), updateAborted()

◆ updateStarted

void updateStarted ( )
signal

This signal is emitted every time the execution thread starts processing the update set. It will only be emitted once up until the whole update set is brought up to date as a whole (ie the whole set is up to date at the one time).

After this signal has been emitted and all slots connected to it have been processed, the action will start an internal timer to allow the elapsed time for this update to be measured.

See also
updateFinished(), updateAborted()