BaseImageYStrip2d.h

// BaseImageYStrip2d.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEYSTRIP2D_H__
#define __IPSDKIMAGE_BASEIMAGEYSTRIP2D_H__

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

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

namespace ipsdk {
namespace image {

class BaseImageYStripColor2d;
class BaseImageYStripSeq2d;
class BaseImageYStrip2dWithKernel;
class BaseImageZStrip3d;


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

    // friend class for protected members access
    friend class BaseImageYStripColor2d;
    friend class BaseImageYStripSeq2d;
    friend class BaseImageYStrip2dWithKernel;
    friend class BaseImageZStrip3d;

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

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

// methods
public:
    eImageStripType                 getImageStripType() const;

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

    const eStripParsingDirection&   getStripParsingDirection() const;

    const eStripParsingDirection&   getLineParsingDirection() const;

    ipUInt64                        getSizeX() const;

    ipUInt64                        getStripStartOffsetY() const;

    ipUInt64                        getStripSizeY() const;

    ipUInt64                        getImageSizeY() const;

    bool                            isValidY(ipUInt64 y) 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 HybridBuffer&             getBuffer() const;

    virtual ipBool                  fromDisk() const;

protected:
    void                    initBase(const ipUInt64 zPlanIdx,
                                     const ipUInt64 cPlanIdx,
                                     const ipUInt64 tPlanIdx,
                                     const ipUInt64 stripStartOffsetY,
                                     const ipUInt64 stripSizeY,
                                     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 HybridBuffer&     accessBuffer() const;
    HybridBuffer&           accessBuffer();

    void                    clearDerived();
                                        

// attributes
private:
    eStripParsingDirection  _stripParsingDirection;

    eStripParsingDirection  _lineParsingDirection;

    ipUInt64                _zPlanIdx;
    ipUInt64                _cPlanIdx;
    ipUInt64                _tPlanIdx;

    ipUInt64                _sizeX;

    ipUInt64                _stripStartOffsetY;

    ipUInt64                _stripSizeY;

    ipUInt64                _imageSizeY;

    eImageBufferType        _bufferType;

    PlanStoragePtr          _pPlanStorage;

    mutable HybridBuffer    _buffer;
};


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

inline const HybridBuffer&
BaseImageYStrip2d::getBuffer() const
{
    return accessBuffer();
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEYSTRIP2D_H__