BaseImageAccessor.h

// BaseImageAccessor.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEACCESSOR_H__
#define __IPSDKIMAGE_BASEIMAGEACCESSOR_H__

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

#include <IPSDKImage/IPSDKImageExports.h>
#include <IPSDKImage/Image/ImageTypes.h>
#include <IPSDKImage/Geometry/ImageGeometryTypes.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API BaseImageAccessor : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BaseImageAccessor);

    // friend class for protected access
    friend class DiskImage;
    friend class DiskPlanStorage;
    friend class UserImage;
    friend class UserPlanStorage;

public:
    BaseImageAccessor();
    virtual ~BaseImageAccessor() = 0;
    
// methods
public:
    bool                                isInit() const;

    const eImageAccessMode&             getAccessMode() const;

    const BaseImageGeometry&            getGeometry() const;

    const GeometricCalibrationConstPtr& getGeometricCalibrationConstPtr() const;

    virtual bool                        hasBinary8BitsStorage() const = 0;

    bool                                isValidPlanIdx(const ipUInt64 zPlanIdx,
                                                       const ipUInt64 cPlanIdx,
                                                       const ipUInt64 tPlanIdx) const;
    bool                                isValidPlanIdx(const PlanIndex& planIdx) const;

    BoolResult                          resize(const BaseImageGeometry& imageGeometry);

    BoolResult                          readRaw(const ipUInt64 zPlanIdx,
                                                const ipUInt64 cPlanIdx,
                                                const ipUInt64 tPlanIdx,
                                                const ipUInt64 pixelStartOffset,
                                                const ipUInt64 nbPixels,
                                                void* pData) const;
    BoolResult                          readRaw(const PlanIndex& planIdx,
                                                const ipUInt64 pixelStartOffset,
                                                const ipUInt64 nbPixels,
                                                void* pData) const;

    BoolResult                          writeRaw(const ipUInt64 zPlanIdx,
                                                 const ipUInt64 cPlanIdx,
                                                 const ipUInt64 tPlanIdx,
                                                 const ipUInt64 pixelStartOffset,
                                                 const ipUInt64 nbPixels,
                                                 const void* pData);
    BoolResult                          writeRaw(const PlanIndex& planIdx,
                                                 const ipUInt64 pixelStartOffset,
                                                 const ipUInt64 nbPixels,
                                                 const void* pData);

    void                                clear();

protected:
    virtual std::string getImageInfoStr() const = 0;

    ImageGeometryPtr    getGeometryPtr();

    void                initBase(const eImageAccessMode& accessMode,
                                 const BaseImageGeometry& geometry,
                                 const GeometricCalibrationConstPtr& pGeometricCalibration);

    virtual BoolResult  resizeData(const BaseImageGeometry& geometry) = 0;

    virtual BoolResult  readRawData(const ipUInt64 zPlanIdx,
                                    const ipUInt64 cPlanIdx,
                                    const ipUInt64 tPlanIdx,
                                    const ipUInt64 pixelsStartOffset,
                                    const ipUInt64 nbPixels,
                                    void* pData) const = 0;

    virtual BoolResult  writeRawData(const ipUInt64 zPlanIdx,
                                     const ipUInt64 cPlanIdx,
                                     const ipUInt64 tPlanIdx,
                                     const ipUInt64 pixelsStartOffset,
                                     const ipUInt64 nbPixels,
                                     const void* pData) = 0;

    virtual void        clearDerived() = 0;

// attributes
protected:
    eImageAccessMode                _accessMode;

    ImageGeometryPtr                _pGeometry;

    GeometricCalibrationConstPtr    _pGeometricCalibration;

    bool                            _bInit;
};


inline bool
BaseImageAccessor::isInit() const
{
    return _bInit;
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEACCESSOR_H__