Workspace 6.21.5
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ParallelIteratingOperationBase Class Referenceabstract

#include <Workspace/DataExecution/Operations/Builtin/paralleliteratingoperationbase.h>

Inheritance diagram for ParallelIteratingOperationBase:
[legend]

Classes

struct  IterationControlParams
 This struct represents the control parameters for a parallel loop. It exists to minimise virtual function calls when obtaining these values from derived classes. More...
 
class  IterationObserver
 

Public Member Functions

virtual void onIterationAborted (Workspace &)=0
 
virtual void onIterationFinished (Workspace &)=0
 
virtual void onIterationSuccess (Workspace &)=0
 
void processAbortedIteration (Workspace &)
 

Protected Member Functions

 ParallelIteratingOperationBase ()
 
virtual ~ParallelIteratingOperationBase ()=default
 
int calcProgress (int startValue, int endValue, int counterValue)
 
virtual IterationControlParams getIterationControlParams () const =0
 
int getIterationCount ()
 
void setMethodDispatcher (ParallelIteratingOperationMethodDispatcher *dispatcher)
 
void sleep (int msec)
 

Protected Attributes

int counterValue_
 
int endValue_
 
bool overflowed_
 
int startValue_
 
int stepValue_
 

Constructor & Destructor Documentation

◆ ParallelIteratingOperationBase()

ParallelIteratingOperationBase ( )
protected

◆ ~ParallelIteratingOperationBase()

virtual ~ParallelIteratingOperationBase ( )
protectedvirtualdefault

Member Function Documentation

◆ calcProgress()

int calcProgress ( int  startValue,
int  endValue,
int  counterValue 
)
protected

◆ getIterationControlParams()

virtual IterationControlParams getIterationControlParams ( ) const
protectedpure virtual

Implemented in CountedLoop.

◆ getIterationCount()

int getIterationCount ( )
protected

◆ onIterationAborted()

virtual void onIterationAborted ( Workspace &  )
pure virtual

Implemented in ParallelIteratingOperation< Derived >, and ParallelIteratingOperation< CountedLoop >.

◆ onIterationFinished()

virtual void onIterationFinished ( Workspace &  )
pure virtual

Implemented in ParallelIteratingOperation< Derived >, and ParallelIteratingOperation< CountedLoop >.

◆ onIterationSuccess()

virtual void onIterationSuccess ( Workspace &  )
pure virtual

Implemented in ParallelIteratingOperation< Derived >, and ParallelIteratingOperation< CountedLoop >.

◆ processAbortedIteration()

void processAbortedIteration ( Workspace &  workspace)

◆ setMethodDispatcher()

void setMethodDispatcher ( ParallelIteratingOperationMethodDispatcher *  dispatcher)
protected
Parameters
dispatcherThe method dispatcher to use when iteration messages are received. This object will take ownership of the dispatcher and be responsible for its deletion.

◆ sleep()

void sleep ( int  msec)
protected

Member Data Documentation

◆ counterValue_

int counterValue_
protected

◆ endValue_

int endValue_
protected

◆ overflowed_

bool overflowed_
protected

◆ startValue_

int startValue_
protected

◆ stepValue_

int stepValue_
protected