BaseImageXStrip2d.h

// BaseImageXStrip2d.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEXSTRIP2D_H__
#define __IPSDKIMAGE_BASEIMAGEXSTRIP2D_H__

// suppression warnings
// warning C4251: 'ipsdk::image::BaseImageXStrip2d::_stripParsingDirection' : class 'ipsdk::image::eStripParsingDirection' needs to have dll-interface to be used by clients of class 'ipsdk::image::BaseImageXStrip2d'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImage/Fragment/Strip/BaseImageStrip.h>
#include <IPSDKBaseData/Buffer/FragHybridBuffer.h>

namespace ipsdk {
namespace image {

class BaseImageXStrip2dWithKernel;


class IPSDKIMAGE_API BaseImageXStrip2d : public BaseImageStrip
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BaseImageXStrip2d)

    // friend class for protected members access
    friend class BaseImageXStrip2dWithKernel;

// predefined public types
public:
    static const eImageStripType::domain g_imageStripType = eImageStripType::eIST_X2d;

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

// methods
public:
    eImageStripType                 getImageStripType() const;

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

    const eStripParsingDirection&   getStripParsingDirection() const;

    ipUInt64                        getSizeY() const;

    ipUInt64                        getStripStartOffsetX() const;

    ipUInt64                        getStripSizeX() const;

    ipUInt64                        getImageSizeX() const;

    bool                            isValidX(ipUInt64 x) const;

    const eImageBufferType&         getBufferType() const;

    const ipUInt64                  getFullStripSize() const;

    const ipUInt64                  getPlanStripSize() const;

    const ipUInt64                  getStripNbPlans() const;

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

    ipUInt64                        getZPlanIdx() const;

    ipUInt64                        getCPlanIdx() const;

    ipUInt64                        getTPlanIdx() const;

    const FragHybridBuffer&         getBuffer() const;

    FragHybridBufferConstPtr        getBufferPtr() const;

protected:
    void                    initBase(const ipUInt64 zPlanIdx,
                                     const ipUInt64 cPlanIdx,
                                     const ipUInt64 tPlanIdx,
                                     const ipUInt64 stripStartOffsetX,
                                     const ipUInt64 stripSizeX,
                                     const eStripAllocationType& stripAllocationType,
                                     const eStripParsingDirection& stripParsingDirection,
                                     const PlanStoragePtr& pPlanStorage,
                                     const DataIdentifierConstPtr& pImageIdentifier,
                                     const DataItemMapConstPtr& pImageHeader);

    bool                    isBufferInitDerived() const;

    BoolResult              initBufferDerived();

    void                    clearBufferDerived();

    eDataAccessMode         retrieveAccessMode() const;

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

    BoolResult              readDataDerived() const;

    BoolResult              writeDataDerived();

    const FragHybridBuffer& accessBuffer() const;
    FragHybridBuffer&       accessBuffer();

    void                    clearDerived();

// attributes
private:
    eStripParsingDirection      _stripParsingDirection;

    ipUInt64                    _zPlanIdx;
    ipUInt64                    _cPlanIdx;
    ipUInt64                    _tPlanIdx;

    ipUInt64                    _sizeY;

    ipUInt64                    _stripStartOffsetX;

    ipUInt64                    _stripSizeX;

    ipUInt64                    _imageSizeX;

    eImageBufferType            _bufferType;

    PlanStoragePtr              _pPlanStorage;

    FragHybridBufferPtr         _pBuffer;
};


inline eImageStripType
BaseImageXStrip2d::getImageStripType() const
{
    return g_imageStripType;
}

inline const FragHybridBuffer&
BaseImageXStrip2d::getBuffer() const
{
    return accessBuffer();
}


} // end of namespace image
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEXSTRIP2D_H__