BaseProcessingAlgorithm.h

// BaseProcessingAlgorithm.h:
// --------------------------
//

#ifndef __IPSDKBASEPROCESSING_BASEPROCESSINGALGORITHM_H__
#define __IPSDKBASEPROCESSING_BASEPROCESSINGALGORITHM_H__

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/Algorithm/Function/InstructionSetsIdentifier.h>
#include <IPSDKBaseProcessing/Algorithm/Parser/DataParserTypes.h>
#include <IPSDKBaseProcessing/Processor/Instances/BaseSyncProcessor.h>
#include <vector>

namespace ipsdk {
namespace processor {

class DataTypeIdentifierColl;
class AlgorithmFunctionSelector;
class AlgorithmFunctionIdentifier;
struct ProcessingInfo;


class IPSDKBASEPROCESSING_API BaseProcessingAlgorithm : public BaseSyncProcessor
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKBaseProcessing, BaseProcessingAlgorithm)

// predefined public types
public:
    typedef DataTypeIdentifierColl DataTypeIdColl;

    typedef AlgorithmFunctionIdentifier FunctionId;

    typedef AlgorithmFunctionSelector FunctionSelector;

    typedef BoolResult (BaseProcessingAlgorithm::*FunctionType)(const ProcessingInfo& info);

protected:
    BaseProcessingAlgorithm();

public:
    virtual ~BaseProcessingAlgorithm() = 0;
    
// methods
public:

protected:
    virtual const FunctionSelector&             getFunctionSelector() const = 0;

    virtual const InstructionSetsIdentifier&    getForcedInstructionSets() const = 0;

    virtual void                                getDataTypeIdColl(DataTypeIdColl& dataTypeIdColl) const = 0;

    typedef std::vector<DataParserPtr> DataParserColl;

    virtual void                                initDataParserColl(DataParserColl& dataParserColl) = 0;

    virtual void                                clearDataParserColl() = 0;

    virtual core::ExecResult                    preProcess() {return core::ExecResult(core::eExecutionResult::eER_Successful);}

    virtual core::ExecResult                    postProcess() {return core::ExecResult(core::eExecutionResult::eER_Successful);}

    virtual void                                getNoParseInfo(ipUInt64& nbDataByElement,
                                                               ipUInt64& nbMaxInitData,
                                                               ipUInt64& nbMaxFinalData) const
    {
        nbDataByElement = -1;
        nbMaxInitData = 0;
        nbMaxFinalData = 0;
    }

private:
    core::ExecResult    execPreProcess();

    core::ExecResult    execPostProcess();

    core::ExecResult    mainProcess();

    void                extractInfo(const DataParserColl& dataParserColl,
                                    ipUInt64& nbElements,
                                    ipUInt64& nbDataByElement,
                                    ipUInt64& nbMaxInitData,
                                    ipUInt64& nbMaxFinalData) const;

    void                initData(const DataParserColl& dataParserColl,
                                 const ipUInt64 nbInitData,
                                 const ipUInt64 nbMainData,
                                 const ipUInt64 nbFinalData,
                                 const ipUInt64 nbRealFinalData);

    void                prepareData(const DataParserColl& dataParserColl,
                                    const ipUInt64 elementIdx);

    BoolResult          processInitData(const DataParserColl& dataParserColl,
                                        const AlgorithmFunctionIdentifier& functionId,
                                        const ipUInt64 elementIdx,
                                        const ipUInt64 nbInitData);

    BoolResult          processMainData(const DataParserColl& dataParserColl,
                                        const AlgorithmFunctionIdentifier& functionId,
                                        const ipUInt64 elementIdx,
                                        const ipUInt64 nbInitData,
                                        const ipUInt64 nbMainData);

    BoolResult          processFinalData(const DataParserColl& dataParserColl,
                                         const AlgorithmFunctionIdentifier& functionId,
                                         const ipUInt64 elementIdx,
                                         const ipUInt64 nbInitData,
                                         const ipUInt64 nbMainData,
                                         const ipUInt64 nbRealFinalData,
                                         const ipUInt64 nbTotFinalData);

// attributes
protected:
    
};


} // end of namespace processor
} // end of namespace ipsdk

#endif // __IPSDKBASEPROCESSING_BASEPROCESSINGALGORITHM_H__