artec::sdk::base::IJob Class Referenceabstract

#include <artec/sdk/base/IJob.h>

+ Inheritance diagram for artec::sdk::base::IJob:

Public Member Functions

virtual const char * getDebugName () const =0
 Returns short job name for debug purposes. More...
virtual unsigned int getThreadsRequired () const =0
virtual ErrorCode start (const AlgorithmWorkset *runSet)=0
virtual ErrorCode process (int threadIndex)=0
virtual ErrorCode finish ()=0
virtual ErrorCode reset ()=0
- Public Member Functions inherited from artec::sdk::base::IRef
virtual int addRef () const =0
virtual int release () const =0

Detailed Description

See also
executeJob, launchJob

Definition at line 65 of file IJob.h.

Member Function Documentation

virtual ErrorCode artec::sdk::base::IJob::finish ( )
pure virtual

Cleans up the environment

The routine is called for the last working thread even if an error occurs
virtual const char* artec::sdk::base::IJob::getDebugName ( ) const
pure virtual

Returns short job name for debug purposes.

Returns the required number of threads

Return values
0Any positive number of threads is applicable.
>0The returned number of threads is mandatory.
virtual unsigned int artec::sdk::base::IJob::getThreadsRequired ( ) const
pure virtual

Sets up the environment, makes a processing schedule

It's called only for the first working thread
virtual ErrorCode artec::sdk::base::IJob::process ( int  threadIndex)
pure virtual

Sums everything up in the end

It's called only for the last working thread in case everything went ok and with no abortions
virtual ErrorCode artec::sdk::base::IJob::reset ( )
pure virtual
virtual ErrorCode artec::sdk::base::IJob::start ( const AlgorithmWorkset runSet)
pure virtual

Executes the algorithm's processing

It's called for all working threads

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