BaseDataParser.h

// BaseDataParser.h:
// -----------------
//

#ifndef __IPSDKBASEPROCESSING_BASEDATAPARSER_H__
#define __IPSDKBASEPROCESSING_BASEDATAPARSER_H__

// suppression warnings
// warning C4275: non dll-interface class 'boost::noncopyable_::noncopyable' used as base for dll-interface class 'ipsdk::processor::BaseDataParser'
// warning C4251: 'ipsdk::processor::BaseDataParser::_attributeIO' : class 'ipsdk::eIOStatus' needs to have dll-interface to be used by clients of class 'ipsdk::processor::BaseDataParser'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/Algorithm/Parser/DataParserTypes.h>
#include <IPSDKBaseProcessing/Attribute/Base/AttributeTypes.h>
#include <IPSDKUtil/BaseTypes.h>
#include <boost/noncopyable.hpp>

namespace ipsdk {
namespace processor {

class BaseProcessingAlgorithm;


class IPSDKBASEPROCESSING_API BaseDataParser : public boost::noncopyable
{
    // friend class for private members access
    friend class BaseProcessingAlgorithm;

public:
    BaseDataParser();
    virtual ~BaseDataParser() = 0;

// methods
public:
    bool                    isInit() const;

    virtual eDataParserType getDataParserType() const = 0;

    //-----------------------------------------
    //-----------------------------------------

    const eIOStatus&        getAttributeIO() const;

    ipUInt64                getNbElements() const;

    ipUInt64                getNbDataByElement() const;

    ipUInt64                getNbMinInitData() const;

    ipUInt64                getNbMinFinalData() const;

    ipUInt64                getCurElementIdx() const;

    //-------------------------------------------
    //-------------------------------------------

    ipReal64                getUnAlignedValue() const;

    void                    setUnAlignedValue(const ipReal64 unAlignedValue);

    bool                    areDataInit() const;

    ipUInt64                getNbInitData() const;

    ipUInt64                getNbMainData() const;

    ipUInt64                getNbFinalData() const;

    ipUInt64                getNbRealFinalData() const;

    void                    clear();

protected:
    void                    initBase(const eIOStatus& attributeIO,
                                     const ipUInt64 nbElements,
                                     const ipUInt64 nbDataByElement,
                                     const ipUInt64 nbMinInitData,
                                     const ipUInt64 nbMinFinalData,
                                     const ipReal64 unAlignedDefaultValue);

    virtual void            clearDerived() {}

    virtual void            initDataDerived(const ipUInt64 nbInitData,
                                            const ipUInt64 nbMainData,
                                            const ipUInt64 nbFinalData,
                                            const ipUInt64 nbRealFinalData,
                                            const ipReal64 unAlignedValue) = 0;

    virtual void            prepareDataDerived(const ipUInt64 elementIdx) = 0;

    virtual void            updateToInitDataDerived() = 0;

    virtual void            updateToMainDataDerived() = 0;

    virtual void            updateToFinalDataDerived() = 0;

    virtual void            syncOutFinalDataDerived() {}

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

    void                    prepareData(const ipUInt64 elementIdx);

private:
    //-----------------------------------------------
    //-----------------------------------------------

    void                    updateToInitData();

    void                    updateToMainData();

    void                    updateToFinalData();

    void                    syncOutFinalData();

// attributes
private:
    eIOStatus               _attributeIO;

    ipUInt64                _nbElements;

    ipUInt64                _nbDataByElement;

    ipUInt64                _nbMinInitData;

    ipUInt64                _nbMinFinalData;

    ipUInt64                _curElementIdx;

    ipUInt64                _nbInitData;

    ipUInt64                _nbMainData;

    ipUInt64                _nbFinalData;

    ipUInt64                _nbRealFinalData;

    bool                    _bDataInit;

    ipReal64                _unAlignedValue;

    bool                    _bInit;
};


inline bool
BaseDataParser::isInit() const
{
    return _bInit;
}


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

#pragma warning (pop)

#endif // __IPSDKBASEPROCESSING_BASEDATAPARSER_H__