Interface that represents a basic multithreaded work item; Used by executeJob and launchJob. More...

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
	Returns the required number of threads. More...

virtual ErrorCode	start (const AlgorithmWorkset *runSet)=0
	Sets the environment up, makes a processing schedule. More...

virtual ErrorCode	process (int threadIndex)=0
	Executes the algorithm's processing. More...

virtual ErrorCode	finish ()=0
	Sums everything up in the end. More...

virtual ErrorCode	reset ()=0
	Cleans the environment up. More...

Public Member Functions inherited from artec::sdk::base::IRef
virtual int	addRef () const =0
	Increase object reference counter. More...

virtual int	release () const =0
	Decrease object reference counter. More...

Detailed Description

Interface that represents a basic multithreaded work item; Used by executeJob and launchJob.

Base for scanning and algorithms.

Definition at line 51 of file IJob.h.

Member Function Documentation

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

pure virtual

Sums everything up in the end.

Note: It's called only for the last working thread in case everything went smoothly and without any abortion.

virtual const char* artec::sdk::base::IJob::getDebugName ( ) const

pure virtual

Returns short job name for debug purposes.

virtual unsigned int artec::sdk::base::IJob::getThreadsRequired ( ) const

pure virtual

Returns the required number of threads.

Return values

0	Any positive number of threads is applicable.
>0	The returned number of threads is mandatory.

virtual ErrorCode artec::sdk::base::IJob::process ( int threadIndex )

pure virtual

Executes the algorithm's processing.

virtual ErrorCode artec::sdk::base::IJob::reset ( )

pure virtual

Cleans the environment up.

Note: The routine is called for the last working thread even if an error occurs

virtual ErrorCode artec::sdk::base::IJob::start ( const AlgorithmWorkset * runSet )

pure virtual

Sets the environment up, makes a processing schedule.

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