BaseUserImageAccessor.h

// BaseUserImageAccessor.h:
// ------------------------
//

#ifndef __IPSDKIMAGE_BASEUSERIMAGEACCESSOR_H__
#define __IPSDKIMAGE_BASEUSERIMAGEACCESSOR_H__

// suppression warning
// warning C4251: 'ipsdk::image::BaseUserImageAccessor::_imageName' : class 'std::basic_string<_Elem,_Traits,_Ax>' needs to have dll-interface to be used by clients of class 'ipsdk::image::BaseUserImageAccessor'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImage/Accessor/BaseImageAccessor.h>

namespace ipsdk {
namespace image {


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

public:
    BaseUserImageAccessor();
    virtual ~BaseUserImageAccessor() = 0;
    
// methods
public:
    const std::string&  getImageName() const;

    const void*         getDataPtr(const ipUInt64 zPlanIdx,
                                   const ipUInt64 cPlanIdx,
                                   const ipUInt64 tPlanIdx) const;
    const void*         getDataPtr(const PlanIndex& planIdx) const;
    void*               getDataPtr(const ipUInt64 zPlanIdx,
                                   const ipUInt64 cPlanIdx,
                                   const ipUInt64 tPlanIdx);
    void*               getDataPtr(const PlanIndex& planIdx);

protected:
    std::string         getImageInfoStr() const;

    void                initBase(const std::string& imageName,
                                 const eImageAccessMode& accessMode,
                                 const BaseImageGeometry& geometry,
                                 const GeometricCalibrationConstPtr& pGeometricCalibration);

    virtual const void* getDataPtrDerived(const ipUInt64 zPlanIdx,
                                          const ipUInt64 cPlanIdx,
                                          const ipUInt64 tPlanIdx) const;
    virtual void*       getDataPtrDerived(const ipUInt64 zPlanIdx,
                                          const ipUInt64 cPlanIdx,
                                          const ipUInt64 tPlanIdx);

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

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

// attributes
private:
    std::string             _imageName;
};


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEUSERIMAGEACCESSOR_H__