artec::sdk::base::AlgorithmWorkset Struct Reference

Workset for algorithm parameters. More...

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

Public Attributes
IModel *	in
	Input model (container of Scans and CompositeContainer etc.) is the input values for algorithm. More...
IModel *	out
	Output model (container of Scans and CompositeContainer etc.) is the result of algorithm. More...
IProgressInfo *	progress
	Progress report callback for an algorithm. More...
ICancellationToken *	cancellation
	Callback to test whether the algorithm has been canceled or terminated. More...
unsigned int	threadsCount
	Thread count for algorithm. More...

Detailed Description

Workset for algorithm parameters.

Pointers to Input and Output models cannot be NULL. For most of algorithms the Input model must be filled with data (usually scans). Output model is empty in the most cases.

Examples:

project-sample.cpp.

Definition at line 25 of file AlgorithmWorkset.h.

Member Data Documentation

ICancellationToken* artec::sdk::base::AlgorithmWorkset::cancellation

Callback to test whether the algorithm has been canceled or terminated.

Examples:

project-sample.cpp.

Definition at line 37 of file AlgorithmWorkset.h.

IModel* artec::sdk::base::AlgorithmWorkset::in

Input model (container of Scans and CompositeContainer etc.) is the input values for algorithm.

Examples:

project-sample.cpp.

Definition at line 28 of file AlgorithmWorkset.h.

IModel* artec::sdk::base::AlgorithmWorkset::out

Output model (container of Scans and CompositeContainer etc.) is the result of algorithm.

Examples:

project-sample.cpp.

Definition at line 31 of file AlgorithmWorkset.h.

IProgressInfo* artec::sdk::base::AlgorithmWorkset::progress

Progress report callback for an algorithm.

Examples:

project-sample.cpp.

Definition at line 34 of file AlgorithmWorkset.h.

unsigned int artec::sdk::base::AlgorithmWorkset::threadsCount

Thread count for algorithm.

Zero means that all available threads are being used.

Definition at line 41 of file AlgorithmWorkset.h.

---

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

• artec/sdk/base/AlgorithmWorkset.h