AlgorithmWorkset.h

Go to the documentation of this file.

/********************************************************************
*
*   Project     Artec 3D Scanning SDK
*
*   Purpose:    Algorithm workset declaration
*
*   Copyright:  Artec Group
*
********************************************************************/

#ifndef _ALGORITHMWORKSET_H_
#define _ALGORITHMWORKSET_H_

#include <artec/sdk/base/BaseSdkDefines.h>
#include <artec/sdk/base/Errors.h>

namespace artec { namespace sdk { namespace base
{

class IModel;
class ICancellationToken;
class IProgressInfo;

/// @brief Workset for algorithms parameters.
/// @details Pointers to Input and Output models cannot be NULL.
/// For the most of algorithms the Input model must be filled with data (usually scans).
/// Output model is empty in the most cases.
struct AlgorithmWorkset
{
    /// Input model (container of Scans and CompositeContainer etc.) is input values for algorithm.
    IModel*             in;

    /// Output model (container of Scans and CompositeContainer etc.) is result of algorithm.
    IModel*             out;

    /// Progress report callback for an algorithm
    IProgressInfo*      progress;

    /// Callback for testing an algorithm against cancellation and immediate stop
    ICancellationToken* cancellation;
    
    /// Count of threads for algorithm.
    /// Zero means use of the all available threads.
    unsigned int        threadsCount;
};

} } } // namespace artec::sdk::base

#endif // _ALGORITHMS_H_