BaseDataSplit.h

// BaseDataSplit.h:
// ----------------
//

#ifndef __IPSDKBASEPROCESSING_BASEDATASPLIT_H__
#define __IPSDKBASEPROCESSING_BASEDATASPLIT_H__

// suppression warning
// warning C4275: non dll-interface class 'boost::noncopyable_::noncopyable' used as base for dll-interface class 'ipsdk::processor::BaseDataSplit'
// warning C4251: 'ipsdk::processor::BaseDataSplit<ProcessorBaseClass>::_elementInfoColl' : class 'std::vector<_Ty>' needs to have dll-interface to be used by clients of class 'ipsdk::processor::BaseDataSplit<ProcessorBaseClass>'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/Processor/ProcessorTypes.h>
#include <IPSDKBaseProcessing/Processor/ProcessorHdrMacros.h>
#include <IPSDKBaseProcessing/DataSplit/DataSplitTypes.h>
#include <boost/noncopyable.hpp>

namespace ipsdk {
namespace processor {


class IPSDKBASEPROCESSING_API BaseDataSplit : public boost::noncopyable
{
public:
    BaseDataSplit();
    virtual ~BaseDataSplit() = 0;
    
// methods
public:
    virtual eSplitBaseType      getSplitBaseType() const = 0;

    virtual const std::string&  getAttributeName() const = 0;

    virtual const std::string&  getAttributeToolTip() const = 0;

    bool                        isInit() const;

    bool                        isSplitted() const;

    const ElementsLocationInfo& getElementsLocationInfo() const;

    ipUInt64                    getFullMemorySize() const;

    bool                        areDataLocalized() const;

    bool                        hasLocalData() const;

    bool                        hasRemoteData() const;

    void                        disableDataLocalization();

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

    ipUInt64                    getNbElements() const;

    ipUInt64                    getDataMemorySize(const ipUInt64 elementIdx) const;

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

    ipUInt64                    getDataMemorySize() const;

protected:
    void                        initBaseSplitted(const ElementsLocationInfo& elementsLocationInfo);

    void                        initBaseUnSplitted(const ElementsLocationInfo& elementsLocationInfo);

    virtual bool                checkProcessorType(const processor::BaseProcessor& processor) = 0;

    void                        throwNullInputSharedPtr();

// attributes
private:
    ElementsLocationInfo    _elementsLocationInfo;

    bool                    _bSplitted;

    bool                    _bInit;
};


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


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

#pragma warning (pop)

#endif // __IPSDKBASEPROCESSING_BASEDATASPLIT_H__