Algorithm Class Reference
[Algorithms]

The abstract algorithm interface. More...

#include <algorithm.h>

Inherits QThread.

Inherited by TestAlgorithm, and ThresholdAlgorithm.

Inheritance diagram for Algorithm:

[legend]List of all members.

Public Slots
void	cancel ()
Signals
void	datasetChangedSignal (dataset_key_type const &dataset_key)
Public Member Functions
	Algorithm ()
virtual	~Algorithm ()
void	run ()=0
void	setConfiguration (imedgine::configuration_pointer_type configuration)
Protected Member Functions
	Algorithm (Algorithm const &src)
Protected Attributes
bool	do_cancel_
imedgine::configuration_pointer_type	configuration_

---

Detailed Description

The abstract algorithm interface.

Algorithm

Provides a run method which has to be overloaded as well as a slot for cancelling and a signal for sending out progress events.

Author:

Tobias Gross (tobias.gross@imedgine.org)

Christian Koerner (christian.koerner@imedgine.org)

Alexander Lex (alexander.lex@imedgine.org)

Marc Streit (marc.streit@imedgine.org)

Martin Reininger (martin.reininger@imedgine.org)

Definition at line 49 of file algorithm.h.

---

Constructor & Destructor Documentation

Algorithm (   )

Constructor Definition at line 21 of file algorithm.cpp.

~Algorithm (   )  [virtual]

Destructor Definition at line 34 of file algorithm.cpp.

Algorithm (  Algorithm const &  src  )  [protected]

Copy constructor Definition at line 28 of file algorithm.cpp.

---

Member Function Documentation

void cancel (   )  [slot]

Called if the algorithm receives a cancel event. Implementors have to cancel the algorithm's processing. TODO success/failure of cancel? via progress? Definition at line 54 of file algorithm.cpp. References Algorithm::do_cancel_.

void datasetChangedSignal (  dataset_key_type const &  dataset_key  )  [signal]

This signal is to be emitted by the algorithm implementor to notify that a dataset changed and thus trigger and update of the dependent views of the dataset (to show intermediate results) Parameters: dataset_key  The unique key of the dataset that has changed (NOTE: This is the dataset key from the core application (as returned by Dataset::getDatasetKey()) not the one from the algorithm config file)

void run (   )  [pure virtual]

Execute the algorithm. Has to be implemented by subclasses. Implemented in TestAlgorithm, and ThresholdAlgorithm.

void setConfiguration (  imedgine::configuration_pointer_type  configuration  )

Sets the configuration of this particular algorithm. Parameters: configuration  a pointer to the AlgorithmConfiguration Returns: void Definition at line 47 of file algorithm.cpp. References Algorithm::configuration_.

---

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

• imedgine/src/algorithms/algorithm.h
• imedgine/src/algorithms/algorithm.cpp

---