mta::MultiThreadedAlgorithm< AlgInput, AlgOutput, AlgThread > Class Template Reference

An algorithm which distributes work between multiply threads. More...

#include <MultiThreadedAlgorithm.h>

List of all members.

Public Member Functions

 MultiThreadedAlgorithm (int threadCount, const AlgInput &input, AlgOutput &output, ProgressReporter *pProgress)
 ~MultiThreadedAlgorithm ()
Result run ()
std::string getErrorText () const


Detailed Description

template<class AlgInput, class AlgOutput, class AlgThread>
class mta::MultiThreadedAlgorithm< AlgInput, AlgOutput, AlgThread >

An algorithm which distributes work between multiply threads.

(SIMD)

Definition at line 636 of file MultiThreadedAlgorithm.h.


Constructor & Destructor Documentation

template<class AlgInput, class AlgOutput, class AlgThread>
mta::MultiThreadedAlgorithm< AlgInput, AlgOutput, AlgThread >::MultiThreadedAlgorithm ( int  threadCount,
const AlgInput &  input,
AlgOutput &  output,
ProgressReporter pProgress 
)

Constructor.

Parameters:
threadCount Number of threads to create.
input Algorithm input.
output Algorithm output.
pProgress Used to report progress and errors.

Definition at line 700 of file MultiThreadedAlgorithm.h.

template<class AlgInput, class AlgOutput, class AlgThread>
mta::MultiThreadedAlgorithm< AlgInput, AlgOutput, AlgThread >::~MultiThreadedAlgorithm (  ) 

Destructor.

Definition at line 713 of file MultiThreadedAlgorithm.h.


Member Function Documentation

template<class AlgInput, class AlgOutput, class AlgThread>
Result mta::MultiThreadedAlgorithm< AlgInput, AlgOutput, AlgThread >::run (  ) 

Execute the algorithm.

Returns:
The result of the execution.

Definition at line 857 of file MultiThreadedAlgorithm.h.

template<class AlgInput, class AlgOutput, class AlgThread>
std::string mta::MultiThreadedAlgorithm< AlgInput, AlgOutput, AlgThread >::getErrorText (  )  const

The last error message.

If the result of run() is an error, this returns the error description.

Returns:
The last error message or an empty string if no error occured.

Definition at line 671 of file MultiThreadedAlgorithm.h.


Software Development Kit - Opticks 4.9.0 Build 16218