BasePlanStorage.h

// BasePlanStorage.h:
// ------------------
//

#ifndef __IPSDKIMAGE_BASEPLANSTORAGE_H__
#define __IPSDKIMAGE_BASEPLANSTORAGE_H__

// suppression warnings
// warning C4251: 'ipsdk::image::BasePlanStorage::_pImageHeader' : class 'boost::shared_ptr<T>' needs to have dll-interface to be used by clients of class 'ipsdk::image::BasePlanStorage'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImage/IPSDKImageExports.h>
#include <IPSDKImage/Storage/PlanStorageTypes.h>
#include <IPSDKImage/Geometry/Plan/ImagePlanGeometry.h>
#include <IPSDKImage/Image/ImageTypes.h>
#include <IPSDKBaseData/Buffer/BufferTypes.h>
#include <IPSDKSerialization/Engine/BaseObjectWithSkeleton.h>

namespace ipsdk {
namespace image {

class BasePlanGeometry;


class IPSDKIMAGE_API BasePlanStorage : public BaseObjectWithSkeleton
{
    // declare dynamic class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BasePlanStorage);

    // friend class for protected access
    friend class SubImage;

public:
    BasePlanStorage();
    virtual ~BasePlanStorage() = 0;
    
// methods
public:
    virtual ePlanStorageType        getPlanStorageType() const = 0;

    bool                            isInit() const;

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

    const ImagePlanGeometry&        getPlanGeometry() const;

    ipUInt64                        getSizeX() const;

    ipUInt64                        getSizeY() const;

    ipUInt64                        getNbPixels() const;

    const eImageBufferType&         getBufferType() const;

    virtual eImageAccessMode        getAccessMode() const = 0;

    virtual const void*             getDataPtr() const;
    virtual void*                   getDataPtr();

    bool                            hasFullDataAccess() const;

    virtual bool                    hasRowDataAccess(const ipUInt64 startOffsetY,
                                                     const ipUInt64 sizeY = 1) const;

    virtual bool                    canBeRemotlyAccessed() const = 0;

    virtual bool                    hasBinary8BitsStorage() const = 0;

    virtual const void*             getRowDataPtr(const ipUInt64 offsetY) const;
    virtual void*                   getRowDataPtr(const ipUInt64 offsetY);

    BoolResult                      resize(const ImagePlanGeometry& planGeometry);

    virtual ipUInt64                getFullBufferSize() const;

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

    BoolResult                      readRaw(const ipUInt64 startOffset,
                                            const ipUInt64 size,
                                            void* pData) const;

    BoolResult                      readArea(const ipUInt64 areaStartOffsetX,
                                             const ipUInt64 areaSizeX,
                                             const ipUInt64 areaStartOffsetY,
                                             const BufferPtrColl& dataColl) const;

    BoolResult                      writeRaw(const ipUInt64 startOffset,
                                             const ipUInt64 size,
                                             const void* pData);

    BoolResult                      writeArea(const ipUInt64 areaStartOffsetX,
                                              const ipUInt64 areaSizeX,
                                              const ipUInt64 areaStartOffsetY,
                                              const BufferConstPtrColl& dataColl);

    void                            clear();

    virtual ipBool                  isDiskPlanStorage() const;

protected:
    void                    initBase(const ImagePlanGeometry& planGeometry);

    virtual BoolResult      resizePlan(const ImagePlanGeometry& planGeometry) = 0;

    virtual BoolResult      readRawData(const ipUInt64 startOffset,
                                        const ipUInt64 size,
                                        void* pData) const = 0;

    virtual BoolResult      readAreaData(const ipUInt64 areaStartOffsetX,
                                         const ipUInt64 areaSizeX,
                                         const ipUInt64 areaStartOffsetY,
                                         const BufferPtrColl& dataColl) const;

    virtual BoolResult      writeRawData(const ipUInt64 startOffset,
                                         const ipUInt64 size,
                                         const void* pData) = 0;

    virtual BoolResult      writeAreaData(const ipUInt64 areaStartOffsetX,
                                          const ipUInt64 areaSizeX,
                                          const ipUInt64 areaStartOffsetY,
                                          const BufferConstPtrColl& dataColl);

    virtual void            clearPlanData() = 0;

// attributes
private:
    ImagePlanGeometry   _planGeometry;

    bool                _bInit;
};


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


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEPLANSTORAGE_H__