BaseDynamicSplit.h

// BaseDynamicSplit.h:
// -------------------
//

#ifndef __IPSDKBASEPROCESSING_BASEDYNAMICSPLIT_H__
#define __IPSDKBASEPROCESSING_BASEDYNAMICSPLIT_H__

#include <IPSDKBaseProcessing/DataSplit/BaseDataSplit.h>
#include <IPSDKBaseProcessing/DataSplit/Dynamic/DynamicSplitTypes.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <IPSDKUtil/Tools/NumericLimits.h>

namespace ipsdk {
namespace processor {


class IPSDKBASEPROCESSING_API BaseDynamicSplit : public BaseDataSplit
{
// predefined public types
public:
    static const eSplitBaseType::domain g_splitBaseType = eSplitBaseType::eSBT_Dynamic;

public:
    BaseDynamicSplit();
    virtual ~BaseDynamicSplit() = 0;
    
// methods
public:
    eSplitBaseType                  getSplitBaseType() const;

    virtual eSplitDynamicType       getSplitDynamicType() const = 0;

    ipUInt64                        getNbMinEltsPerSplit() const;

    ipUInt64                        getNbMaxEltsPerSplit() const;

    BoolResult                      initAttribute(BaseProcessor& processor,
                                                  const ipUInt64 elementsStartIndex,
                                                  const ipUInt64 nbElements,
                                                  const core::BaseRequestOrigin& requestOrigin);

protected:
    void                            initSplitted(const ElementsLocationInfo& elementsLocationInfo,
                                                 const ipUInt64 nbMinEltsPerSplit = 1,
                                                 const ipUInt64 nbMaxEltsPerSplit = NumericLimits<ipUInt64>::max());

    void                            initUnSplitted(const ElementsLocationInfo& elementsLocationInfo);

    virtual BoolResult              processAttribute(BaseProcessor& processor,
                                                     const ipUInt64 elementsStartIndex,
                                                     const ipUInt64 nbElements,
                                                     const core::BaseRequestOrigin& requestOrigin) = 0;

private:
    // private export of base class method to avoid direct call
    // from derived classes
    using BaseDataSplit::initBaseSplitted;
    using BaseDataSplit::initBaseUnSplitted;

// attributes
protected:
    ipUInt64                    _nbMinEltsPerSplit;

    ipUInt64                    _nbMaxEltsPerSplit;
};


inline eSplitBaseType
BaseDynamicSplit::getSplitBaseType() const
{
    return g_splitBaseType;
}


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

#endif // __IPSDKBASEPROCESSING_BASEDYNAMICSPLIT_H__