BaseImageZStrip3d.h

// BaseImageZStrip3d.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEZSTRIP3D_H__
#define __IPSDKIMAGE_BASEIMAGEZSTRIP3D_H__

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

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

namespace ipsdk {
namespace image {

class BaseImageZStrip3dWithKernel;


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

    // friend class for protected members access
    friend class BaseImageZStrip3dWithKernel;
    friend class BaseImageZStripColor3d;

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

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

// methods
public:
    eImageStripType                 getImageStripType() const;

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

    const eStripParsingDirection&   getStripParsingDirection() const;

    ipUInt64                        getSizeX() const;

    ipUInt64                        getSizeY() const;

    ipUInt64                        getStripStartOffsetZ() const;

    ipUInt64                        getStripSizeZ() const;

    ipUInt64                        getImageSizeZ() const;

    bool                            isValidZ(ipUInt64 z) const;

    const eImageBufferType&         getBufferType() const;

    const ipUInt64                  getFullStripSize() const;

    const ipUInt64                  getPlanStripSize() const;

    const ipUInt64                  getStripNbPlans() const;

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

    ipUInt64                        getCPlanIdx() const;

    ipUInt64                        getTPlanIdx() const;
    
    const HybridBuffer&             getBuffer(const ipUInt64 zPlanIdx) const;

    ImageYStrip2dConstPtr           getImageYStrip2dPtr(const ipUInt64 zPlanIdx) const;
    ImageYStrip2dPtr                getImageYStrip2dPtr(const ipUInt64 zPlanIdx);

    virtual ipBool                  fromDisk() const;

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

    void                    clearDerived();

    virtual void            createSubStrip(const ipUInt64 zPlanIdx,
                                           const ipUInt64 cPlanIdx,
                                           const ipUInt64 tPlanIdx,
                                           const eStripAllocationType& stripAllocationType,
                                           const eStripParsingDirection& stripParsingDirection,
                                           const PlanStoragePtr& pPlanStorage,
                                           const DataIdentifierConstPtr& pImageIdentifier,
                                           const DataItemMapConstPtr& pImageHeader,
                                           ImageYStrip2dPtr& pImageYStrip2d) const = 0;

// attributes
private:
    eStripParsingDirection      _stripParsingDirection;

    ipUInt64                    _cPlanIdx;
    ipUInt64                    _tPlanIdx;

    ipUInt64                    _sizeX;

    ipUInt64                    _sizeY;

    ipUInt64                    _stripStartOffsetZ;

    ipUInt64                    _stripSizeZ;

    ipUInt64                    _imageSizeZ;

    eImageBufferType            _bufferType;

    PlanStorageColl1d           _volumeColl;

    typedef std::vector<ImageYStrip2dPtr> ImageYStrip2dColl;

    ImageYStrip2dColl           _imageYStrip2dColl;
};


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

inline const HybridBuffer&
BaseImageZStrip3d::getBuffer(const ipUInt64 zPlanIdx) const
{
    return accessBuffer(zPlanIdx);
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEZSTRIP3D_H__