BaseImageTile3d.h

// BaseImageTile3d.h:
// ------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGETILE3D_H__
#define __IPSDKIMAGE_BASEIMAGETILE3D_H__

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

#include <IPSDKImage/Fragment/Tile/BaseImageTile.h>
#include <IPSDKBaseData/Buffer/BufferTypes.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API BaseImageTile3d : public BaseImageTile
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BaseImageTile3d)

// predefined public types
public:
    static const eImageTileType::domain g_imageTileType = eImageTileType::eITT_3d;

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

// methods
public:
    eImageTileType              getImageTileType() const;
    
    ipUInt64                    getImageSizeX() const;
    ipUInt64                    getImageSizeY() const;
    ipUInt64                    getImageSizeZ() const;

    ipInt64                     getTileStartOffsetX() const;
    ipInt64                     getTileStartOffsetY() const;
    ipInt64                     getTileStartOffsetZ() const;

    ipUInt64                    getTileSizeX() const;
    ipUInt64                    getTileSizeY() const;
    ipUInt64                    getTileSizeZ() const;

    ipUInt64                    getTileEndOffsetX() const;
    ipUInt64                    getTileEndOffsetY() const;
    ipUInt64                    getTileEndOffsetZ() const;

    const eImageBufferType&     getBufferType() const;

    const ipUInt64              getFullTileSize() const;

    const ipUInt64              getPlanTileSize() const;

    const ipUInt64              getTileNbPlans() const;

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

    ipUInt64                    getCPlanIdx() const;

    ipUInt64                    getTPlanIdx() const;

    const FragHybridBuffer&     getBuffer(const ipUInt64 zPlanIdx) const;

    template <typename T>
    const T*                    getBuffer(const ipUInt64 zPlanIdx, const ipUInt64 rowIdx) const
    {
        return static_cast<const T*>(accessBuffer(zPlanIdx, rowIdx));
    }

protected:
    void                    initBase(const ipUInt64 cPlanIdx,
                                     const ipUInt64 tPlanIdx,
                                     const ipInt64 tileStartOffsetX,
                                     const ipInt64 tileStartOffsetY,
                                     const ipInt64 tileStartOffsetZ,
                                     const ipUInt64 tileSizeX,
                                     const ipUInt64 tileSizeY,
                                     const ipUInt64 tileSizeZ,
                                     const PlanStorageColl1d& volumeColl,
                                     const DataIdentifierConstPtr& pImageIdentifier,
                                     const DataItemMapConstPtr& pImageHeader);

    bool                    isBufferInitDerived() const;

    BoolResult              initBufferDerived();

    void                    clearBufferDerived();

    eDataAccessMode         retrieveAccessMode() const;

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

    BoolResult              readDataDerived() const;

    BoolResult              writeDataDerived();

    FragHybridBuffer&       accessBuffer(const ipUInt64 zPlanIdx) const;

    const void*             accessBuffer(const ipUInt64 zPlanIdx,
                                         const ipUInt64 rowIdx) const;
    void*                   accessBuffer(const ipUInt64 zPlanIdx,
                                         const ipUInt64 rowIdx);

    void                    clearDerived();

    void                    retrieveIntersection(tile::ImageTileInfo3d& imageTileInfo3d) const;

    typedef std::vector<ImageTile2dPtr> ImageTile2dColl;

    const ImageTile2dColl&  accessImageTile2dColl() const;

    virtual void            createSubTile(const ipUInt64 zPlanIdx,
                                          const ipUInt64 cPlanIdx,
                                          const ipUInt64 tPlanIdx,
                                          const tile::ImageTileInfo3d& imageTileInfo3d,
                                          const PlanStoragePtr& pPlanStorage,
                                          const DataIdentifierConstPtr& pImageIdentifier,
                                          const DataItemMapConstPtr& pImageHeader,
                                          ImageTile2dPtr& pImageTile2d) const = 0;

    virtual void            createSubTile(const ipUInt64 zPlanIdx,
                                          const ipUInt64 cPlanIdx,
                                          const ipUInt64 tPlanIdx,
                                          const tile::ImageTileInfo3d& imageTileInfo3d,
                                          const eImageBufferType& imageBufferType,
                                          const DataIdentifierConstPtr& pImageIdentifier,
                                          const DataItemMapConstPtr& pImageHeader,
                                          ImageTile2dPtr& pImageTile2d) const = 0;

// attributes
private:
    ipUInt64                    _cPlanIdx;
    ipUInt64                    _tPlanIdx;

    ipUInt64                    _imageSizeX;
    ipUInt64                    _imageSizeY;
    ipUInt64                    _imageSizeZ;

    ipInt64                     _tileStartOffsetX;
    ipInt64                     _tileStartOffsetY;
    ipInt64                     _tileStartOffsetZ;

    ipUInt64                    _tileSizeX;
    ipUInt64                    _tileSizeY;
    ipUInt64                    _tileSizeZ;

    eImageBufferType            _bufferType;

    PlanStorageColl1d           _volumeColl;

    ImageTile2dColl             _imageTile2dColl;
};


inline eImageTileType
BaseImageTile3d::getImageTileType() const
{
    return g_imageTileType;
}

inline const FragHybridBuffer&
BaseImageTile3d::getBuffer(const ipUInt64 zPlanIdx) const
{
    return accessBuffer(zPlanIdx);
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGETILE3D_H__