BaseImageFragment.h

// BaseImageFragment.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEFRAGMENT_H__
#define __IPSDKIMAGE_BASEIMAGEFRAGMENT_H__

// suppression warnings
// warning C4251: 'ipsdk::image::BaseImageFragment::_pImageIdentifier' : class 'boost::shared_ptr<T>' needs to have dll-interface to be used by clients of class 'ipsdk::image::BaseImageFragment'
// warning C4275: non dll-interface class 'ipsdk::BaseIOData' used as base for dll-interface class 'ipsdk::image::BaseImageFragment'
#pragma warning (push)
#pragma warning (disable : 4251 4275)

#include <IPSDKImage/IPSDKImageExports.h>
#include <IPSDKImage/Fragment/ImageFragmentTypes.h>
#include <IPSDKBaseData/DataItem/DataItemTypes.h>
#include <IPSDKBaseData/Identifier/DataIdentifierTypes.h>
#include <IPSDKBaseData/DataStatus/BaseIOData.h>
#include <IPSDKSerialization/Engine/BaseObjectWithSkeleton.h>

namespace ipsdk {
namespace image {

struct ImageFragmentExtractor;


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

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

// methods
public:
    virtual eImageFragmentType      getImageFragmentType() const = 0;

    virtual bool                    isInput() const = 0;

    virtual bool                    isOutput() const = 0;

    bool                            isInOut() const
    {
        return isInput() == true &&
               isOutput() == true;
    }

    bool                            isInit() const;

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

    const Guid&                     getGuid() const;

    const std::string&              getName() const;

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

    bool                            existsHeaderKey(const std::string& key) const;

    ItemNames                       getHeaderKeys() const;

    const BaseDataItem&             getHeaderItem(const std::string& key) const;

    eDataAccessMode                 getDataAccessMode() const;

    bool                            hasLocalDataAccess() const;

    bool                            isBufferInit() const;

    BoolResult                      initBuffer();

    void                            clearBuffer();

    bool                            isBufferSyncInput() const;

    bool                            isBufferSyncOutput() const;

    void                            clear();

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

    virtual eDataAccessMode         retrieveAccessMode() const = 0;

    virtual void                    clearDerived() = 0;

    virtual bool                    isBufferInitDerived() const = 0;

    virtual BoolResult              initBufferDerived() = 0;

    virtual void                    clearBufferDerived() = 0;

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

    BoolResult              readData() const;

    virtual BoolResult      readDataDerived() const = 0;

    BoolResult              writeData();

    virtual BoolResult      writeDataDerived() = 0;

// attributes
private:
    DataIdentifierConstPtr  _pImageIdentifier;

    DataItemMapConstPtr     _pImageHeader;

    mutable bool            _bBufferSyncInput;

    bool                    _bBufferSyncOutput;

    bool                    _bInit;
};


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


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEFRAGMENT_H__