mta Namespace Reference

MTA is the Multi-Threaded Algorithm namespace. More...


Classes

class  ThreadCommand
 An action that can be run. More...
class  ThreadReporter
 Report progress and errors from a thread. More...
class  MultiThreadReporter
 Communicates between a processing thread and the main thread. More...
class  AlgorithmThread
 Base class for an algorithm thread. More...
class  ProgressReporter
 Base progress reporting class. More...
class  ProgressObjectReporter
 Use this derived class to report to a progress object. More...
class  StatusBarReporter
 Use this derived class to report to the status bar. More...
class  MultiPhaseProgressReporter
 Use this class to report progress from a multi-phase algorithm. More...
class  MultiThreadedAlgorithm
 An algorithm which distributes work between multiply threads. More...

Typedefs

typedef EnumWrapper< ResultEnumResult

Enumerations

enum  ResultEnum { SUCCESS, FAILURE, ABORT }

Functions

unsigned int getNumRequiredThreads (unsigned int dataSize)


Detailed Description

MTA is the Multi-Threaded Algorithm namespace.

Typedef Documentation

typedef EnumWrapper<ResultEnum> mta::Result

The EnumWrapper contains a given enum value and provides a isValid() method which returns true if the contained enum value is valid.

Please see How To Use EnumWrapper for more information. The wrapped enum values are mta::ResultEnum.

Definition at line 55 of file MultiThreadedAlgorithm.h.


Enumeration Type Documentation

Represents the result of algorithm execution.

Enumerator:
SUCCESS 
FAILURE 
ABORT 

Definition at line 50 of file MultiThreadedAlgorithm.h.


Function Documentation

unsigned int mta::getNumRequiredThreads ( unsigned int  dataSize  ) 

Calculate the required number of threads for the data to be processed.

Using this prevents some oddities involving empty worker threads.

Parameters:
dataSize Size of the data to be processed by multiple threads.
Returns:
The number of threads required to process the data.


Software Development Kit - Opticks 4.8.0 Build 15482