BaseImageYStrip3d.h

// BaseImageYStrip3d.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEYSTRIP3D_H__
#define __IPSDKIMAGE_BASEIMAGEYSTRIP3D_H__

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

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

namespace ipsdk {
namespace image {


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

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

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

// methods
public:
    eImageStripType                 getImageStripType() const;

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

    const eStripParsingDirection&   getStripParsingDirection() const;

    ipUInt64                        getSizeX() const;

    ipUInt64                        getSizeZ() 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                        getCPlanIdx() const;

    ipUInt64                        getTPlanIdx() const;

    const FragHybridBuffer&         getBuffer(const ipUInt64 yPlanIdx) const;

protected:
    void                    initBase(const ipUInt64 cPlanIdx,
                                     const ipUInt64 tPlanIdx,
                                     const ipUInt64 stripStartOffsetY,
                                     const ipUInt64 stripSizeY,
                                     const eStripAllocationType& stripAllocationType,
                                     const eStripParsingDirection& stripParsingDirection,
                                     const PlanStorageColl1d& volumeColl,
                                     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 ipUInt64 yPlanIdx) const;
    FragHybridBuffer&       accessBuffer(const ipUInt64 yPlanIdx);

    void                    clearDerived();

// attributes
private:
    eStripParsingDirection          _stripParsingDirection;

    ipUInt64                        _cPlanIdx;
    ipUInt64                        _tPlanIdx;

    ipUInt64                        _sizeX;

    ipUInt64                        _sizeZ;

    ipUInt64                        _stripStartOffsetY;

    ipUInt64                        _stripSizeY;

    ipUInt64                        _imageSizeY;

    eImageBufferType                _bufferType;

    PlanStorageColl1d               _volumeColl;

    typedef std::vector<FragHybridBuffer> FragHybridBufferColl;

    mutable FragHybridBufferColl    _fragHybridBufferColl;
};


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

inline const FragHybridBuffer&
BaseImageYStrip3d::getBuffer(const ipUInt64 yPlanIdx) const
{
    return accessBuffer(yPlanIdx);
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEYSTRIP3D_H__