CustusX  2023.01.05-dev+develop.0da12
An IGT application
Public Member Functions | List of all members
cx::CompositeSerialTimedAlgorithm Class Reference
CustusX System » Resource Layer » Core » Algorithms

#include <cxCompositeTimedAlgorithm.h>

Inheritance diagram for cx::CompositeSerialTimedAlgorithm:
cx::CompositeTimedAlgorithm cx::TimedBaseAlgorithm

Public Member Functions

 CompositeSerialTimedAlgorithm (QString name="composite")
 
virtual void clear ()
 
virtual QString getProduct () const
 
virtual void execute ()
 
virtual bool isFinished () const
 
virtual bool isRunning () const
 
- Public Member Functions inherited from cx::CompositeTimedAlgorithm
 CompositeTimedAlgorithm (QString name)
 
virtual void append (TimedAlgorithmPtr child)
 
- Public Member Functions inherited from cx::TimedBaseAlgorithm
 TimedBaseAlgorithm (QString product, int secondsBetweenAnnounce)
 
virtual ~TimedBaseAlgorithm ()
 

Additional Inherited Members

- Signals inherited from cx::TimedBaseAlgorithm
void aboutToStart ()
 emitted at start of execute. Use to perform preprocessing More...
 
void started (int maxSteps)
 emitted at start of run. More...
 
void finished ()
 should be emitted when at the end of postProcessingSlot More...
 
void productChanged ()
 emitted whenever product string has changed More...
 
- Protected Slots inherited from cx::TimedBaseAlgorithm
virtual void finishedSlot ()
 
virtual void postProcessingSlot ()
 
- Protected Member Functions inherited from cx::TimedBaseAlgorithm
void startTiming ()
 
void stopTiming ()
 
QString getSecondsPassedAsString () const
 
- Protected Attributes inherited from cx::CompositeTimedAlgorithm
std::vector< TimedAlgorithmPtr > mChildren
 
- Protected Attributes inherited from cx::TimedBaseAlgorithm
bool mUseDefaultMessages
 

Detailed Description

Composition of several TimedBaseAlgorithms executing in a sequence.

Usage: Append all algorithms as children then execute. All children will be executed in sequence. started()/finished() will also work.

Date
Jun 27, 2012
Author
Christian Askeland

Definition at line 51 of file cxCompositeTimedAlgorithm.h.

Constructor & Destructor Documentation

cx::CompositeSerialTimedAlgorithm::CompositeSerialTimedAlgorithm ( QString  name = "composite")
explicit

Definition at line 36 of file cxCompositeTimedAlgorithm.cpp.

Member Function Documentation

void cx::CompositeSerialTimedAlgorithm::clear ( )
virtual

Implements cx::CompositeTimedAlgorithm.

Definition at line 51 of file cxCompositeTimedAlgorithm.cpp.

void cx::CompositeSerialTimedAlgorithm::execute ( )
virtual

Execute the algorithm. Parts of the execution can be in another thread, thus the call usually returns after preprocessing is complete. The exec starts by emitting aboutToStart(), which can be used by callers to set input arguments.

Implements cx::TimedBaseAlgorithm.

Definition at line 64 of file cxCompositeTimedAlgorithm.cpp.

QString cx::CompositeSerialTimedAlgorithm::getProduct ( ) const
virtual

Reimplemented from cx::TimedBaseAlgorithm.

Definition at line 42 of file cxCompositeTimedAlgorithm.cpp.

bool cx::CompositeSerialTimedAlgorithm::isFinished ( ) const
virtual

Returns true after the finished() signal is emitted.

Implements cx::TimedBaseAlgorithm.

Definition at line 100 of file cxCompositeTimedAlgorithm.cpp.

bool cx::CompositeSerialTimedAlgorithm::isRunning ( ) const
virtual

Returns true if preprocess is started and postprocess not complete. (Right after aboutToStart, right before finished())

Implements cx::TimedBaseAlgorithm.

Definition at line 105 of file cxCompositeTimedAlgorithm.cpp.

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