DistributedPlanStorage.h

// DistributedPlanStorage.h:
// -------------------------
//

#ifndef __IPSDKIMAGE_DISTRIBUTEDPLANSTORAGE_H__
#define __IPSDKIMAGE_DISTRIBUTEDPLANSTORAGE_H__

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

#include <IPSDKImage/Storage/BasePlanStorage.h>
#include <IPSDKImage/Image/Distributed/DistributedImageTypes.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API DistributedPlanStorage : public BasePlanStorage
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKImage, DistributedPlanStorage)

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

public:
    DistributedPlanStorage();
    ~DistributedPlanStorage();

// methods
public:
    ePlanStorageType                getPlanStorageType() const;

    void                            init(const ImagePlanGeometry& planGeometry,
                                         const DataIdentifierConstPtr& pImageIdentifier,
                                         const PlanIndex& planIndex,
                                         const LocationMap& locationMap);

    const DataIdentifierConstPtr&   getImageIdentifier() const;

    const Guid&                     getImageGuid() const;

    const std::string&              getImageName() const;

    const PlanIndex&                getPlanIndex() const;

    ipUInt64                        getZPlanIdx() const;

    ipUInt64                        getCPlanIdx() const;

    ipUInt64                        getTPlanIdx() const;

    const LocationMap&              getLocationMap() const;

    void                            getGuidSet(const ipUInt64 startOffsetY,
                                               const ipUInt64 sizeY,
                                               GuidSet& guidSet) const;

    void                            getGuidSet(GuidSet& guidSet) const;

    eImageAccessMode                getAccessMode() const;

    bool                            hasRowDataAccess(const ipUInt64 startOffsetY,
                                                     const ipUInt64 sizeY = 1) const;

    bool                            canBeRemotlyAccessed() const;
    
    bool                            hasBinary8BitsStorage() const;

    const void*                     getRowDataPtr(const ipUInt64 offsetY) const;
    void*                           getRowDataPtr(const ipUInt64 offsetY);

    bool                            hasRemoteData() const;

protected:
    BoolResult              resizePlan(const ImagePlanGeometry& planGeometry);

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

    BoolResult              readAreaData(const ipUInt64 areaStartOffsetX,
                                         const ipUInt64 areaSizeX,
                                         const ipUInt64 areaStartOffsetY,
                                         const BufferPtrColl& dataColl) const;

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

    BoolResult              writeAreaData(const ipUInt64 areaStartOffsetX,
                                          const ipUInt64 areaSizeX,
                                          const ipUInt64 areaStartOffsetY,
                                          const BufferConstPtrColl& dataColl);

    void                    clearPlanData();

// attributes
protected:
    DataIdentifierConstPtr              _pImageIdentifier;

    PlanIndex                           _planIndex;

    LocationMap                         _locationMap;

    bool                                _bOwnData;
};


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


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_DISTRIBUTEDPLANSTORAGE_H__