IScanningProcedureBundle.h

Go to the documentation of this file.

/********************************************************************
*
*   Project     Artec 3D Scanning SDK
*
*   Purpose:    Scanning by scanner bundle procedure.
*
*   Copyright:  Artec Group
*
********************************************************************/

#ifndef _ISCANNINGPROCEDUREBUNDLE_H_
#define _ISCANNINGPROCEDUREBUNDLE_H_

#include <artec/sdk/base/Errors.h>
#include <artec/sdk/scanning/IScanningProcedure.h>
#include <artec/sdk/scanning/IArrayScanner.h>
#include <artec/sdk/scanning/ScanningSdkDefines.h>

namespace artec { namespace sdk { namespace scanning
{
using namespace artec::sdk::base::errors;

class IScanningProcedureBundle;

struct ScanningProcedureBundleSettings
{
    /// use same setting for each scanning procedure
    ScanningProcedureSettings   procedureSettings;
    
    /// run each scanning procedure in threadCountPerScanner threads number
    /// set threadCountPerScanner to 0 for all available threads
    int                         threadCountPerScanner;

    bool                        useHardwareSynchronization;
};

extern "C"
{

///@{
/** Create procedure for scanning by scanners bundle
*   @param  job - procedure interface to create
*   @param  scanners - scanners list. zero index scanner in master 
*   @param  desc - scanning procedure setting. same for all scanners
*   @return error code
*/
ErrorCode ASCANNINGSDK_LINK_SPEC
    createScanningProcedureBundle(IScanningProcedureBundle** job, IArrayScanner* scanners, const ScanningProcedureBundleSettings* desc = NULL);
}

class IScanningProcedureBundle : public artec::sdk::base::IJob
{
public:
    ///get current scanning event handler
    virtual ScanningState getState() = 0;

    ///set new scanning  event handler
    virtual ErrorCode setState( ScanningState state ) = 0;
};

} } } // namespace artec::sdk::scanning

#endif // _ISCANNINGPROCEDUREBUNDLE_H_