UserPlanStorage.h

// UserPlanStorage.h:
// ------------------
//

#ifndef __IPSDKIMAGE_USERPLANSTORAGE_H__
#define __IPSDKIMAGE_USERPLANSTORAGE_H__

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

#include <IPSDKImage/Storage/BasePlanStorage.h>
#include <IPSDKImage/Image/User/UserImageTypes.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API UserPlanStorage : public BasePlanStorage
{
    // declare dynamic serializable class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKImage, UserPlanStorage);

// predefined public types
public:
    static const ePlanStorageType::domain g_planStorageType = ePlanStorageType::ePST_User;

public:
    UserPlanStorage();
    ~UserPlanStorage();
    
// methods
public:
    ePlanStorageType                getPlanStorageType() const;

    void                            init(UserImageAccessorPtr& pUserImageAccessor,
                                         ipUInt64 zPlanIdx,
                                         ipUInt64 cPlanIdx,
                                         ipUInt64 tPlanIdx);

    const BaseUserImageAccessor&    getUserImageAccessor() const;

    ipUInt64                        getZPlanIdx() const;

    ipUInt64                        getCPlanIdx() const;

    ipUInt64                        getTPlanIdx() const;

    eImageAccessMode                getAccessMode() const;

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

    bool                            canBeRemotlyAccessed() const;

    bool                            hasBinary8BitsStorage() const;

protected:
    BoolResult              resizePlan(const ImagePlanGeometry& planGeometry);

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

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

    void                    clearPlanData();

// attributes
protected:
    UserImageAccessorPtr    _pUserImageAccessor;

    ipUInt64                _zPlanIdx;

    ipUInt64                _cPlanIdx;

    ipUInt64                _tPlanIdx;
};


inline ePlanStorageType
UserPlanStorage::getPlanStorageType() const
{
    return g_planStorageType;
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_USERPLANSTORAGE_H__