SubImage.h

// SubImage.h:
// -----------
//

#ifndef __IPSDKIMAGE_SUBIMAGE_H__
#define __IPSDKIMAGE_SUBIMAGE_H__

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

#include <IPSDKImage/Image/BaseImage.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API SubImage : public BaseImage
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKImage, SubImage);

    // friend class for protected members access
    friend struct SubImageExtractor;
    friend boost::shared_ptr<SubImage> boost::make_shared<SubImage>();

// predefined public types
public:
    static const eImageBaseType::domain g_imageBaseType = eImageBaseType::eIBT_Sub;

protected:
    SubImage();

public:
    ~SubImage();
    
// methods
public:
    eImageBaseType      getImageBaseType() const;

    ipBool              isGpuImage() const;

    ipBool              isDiskImage() const;

    eImageAccessMode    getAccessMode() const;

    bool                hasRemoteStorage() const;

    virtual BoolResult                  init(const BaseImageGeometry& geometry);

protected:
    BoolResult          init(const DataIdentifierConstPtr& pImageIdentifier,
                             const DataItemMapConstPtr& pImageHeader,
                             const eImageAccessMode& imageAccessMode,
                             const ImageGeometryPtr& pSubImageGeometry,
                             const GeometricCalibrationConstPtr& pGeometricCalibration,
                             const ipBool bIsGpuImage,
                             const ipBool bIsDiskImage,
                             PlanStorageColl3d& imagePlans);

// attributes
protected:
    eImageAccessMode        _imageAccessMode;

    ipBool                  _bIsGpuImage;

    ipBool                  _bIsDiskImage;
};


inline eImageBaseType
SubImage::getImageBaseType() const
{
    return g_imageBaseType;
}

inline ipBool
SubImage::isGpuImage() const
{
    return _bIsGpuImage;
}

inline ipBool
SubImage::isDiskImage() const
{
    return _bIsDiskImage;
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_SUBIMAGE_H__