BaseImageStrip.h

// BaseImageStrip.h:
// -----------------
//

#ifndef __IPSDKIMAGE_BASEIMAGESTRIP_H__
#define __IPSDKIMAGE_BASEIMAGESTRIP_H__

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

#include <IPSDKImage/Fragment/BaseImageFragment.h>
#include <IPSDKImage/Fragment/Strip/ImageStripTypes.h>

namespace ipsdk {
namespace image {

struct ImageStripExtractor;


class IPSDKIMAGE_API BaseImageStrip : public BaseImageFragment
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BaseImageStrip)

// predefined public types
public:
    static const eImageFragmentType::domain g_imageFragmentType = eImageFragmentType::eIFT_ImageStrip;

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

// methods
public:
    eImageFragmentType              getImageFragmentType() const;

    virtual eImageStripType         getImageStripType() const = 0;

    virtual const eImageBufferType& getBufferType() const = 0;

    virtual const ipUInt64          getFullStripSize() const = 0;

    virtual const ipUInt64          getPlanStripSize() const = 0;

    virtual const ipUInt64          getStripNbPlans() const = 0;

    const eStripAllocationType&     getStripAllocationType() const;

    virtual ipBool                  fromDisk() const;

protected:
    void                            initBase(const DataIdentifierConstPtr& pImageIdentifier,
                                             const DataItemMapConstPtr& pImageHeader,
                                             const eStripAllocationType& stripAllocationType);

// attributes
protected:
    eStripAllocationType        _stripAllocationType;
};


inline eImageFragmentType
BaseImageStrip::getImageFragmentType() const
{
    return g_imageFragmentType;
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGESTRIP_H__