ElementsLocationInfo.h

// ElementsLocationInfo.h:
// -----------------------
//

#ifndef __IPSDKBASEPROCESSING_ELEMENTSLOCATIONINFO_H__
#define __IPSDKBASEPROCESSING_ELEMENTSLOCATIONINFO_H__

// suppression warnings
// warning C4251: 'ipsdk::processor::ElementsLocationInfo::_elementsLocations' : class 'std::map<_Kty,_Ty>' needs to have dll-interface to be used 
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/ProcessorDispatcher/ElementsInfo/ElementsInfoTypes.h>

namespace ipsdk {
namespace processor {


class IPSDKBASEPROCESSING_API ElementsLocationInfo
{
public:
    ElementsLocationInfo();
    ElementsLocationInfo(const ElementsLocationInfo& elementsLocationInfo);
    ElementsLocationInfo& operator=(const ElementsLocationInfo& elementsLocationInfo);
    ~ElementsLocationInfo();

// methods
public:
    ipUInt64                getStartOffset() const;

    ipUInt64                getNbElements() const;

    ipUInt64                insertNonLocalized(const ElementsRange& elementsRange,
                                               const ipUInt64 dataMemorySize);

    ipUInt64                insertLocal(const ElementsRange& elementsRange,
                                        const ipUInt64 dataMemorySize);

    ipUInt64                insertRemote(const ElementsRange& elementsRange,
                                         const Guid& guid,
                                         const ipUInt64 dataMemorySize);
    ipUInt64                insertRemote(const ElementsRange& elementsRange,
                                         const GuidSet& guidSet,
                                         const ipUInt64 dataMemorySize);

    bool                    areDataLocalized() const;

    bool                    hasLocalData() const;

    bool                    hasRemoteData() const;

    bool                    hasRemoteData(const Guid& socketGuid) const;

    const GuidSet&          getRemoteLocations() const;

    ipUInt64                getFullDataMemorySize() const;

    const ElementsLocation& getElementsLocation() const;

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

    bool                    contains(const ipUInt64 elementIdx) const;

    bool                    contains(const ElementsRange& elementsRange) const;

    const GuidSet&          getDataLocations(const ipUInt64 elementIdx) const;

    ipUInt64                getDataMemorySize(const ipUInt64 elementIdx) const;

    ipUInt64                getDataMemorySize(const ElementsRange& elementsRange) const;

    bool                    areDataLocalized(const ipUInt64 elementIdx) const;

    bool                    hasLocalData(const ipUInt64 elementIdx) const;

    bool                    hasRemoteData(const ipUInt64 elementIdx) const;

    ipUInt64                getMinNbElements() const;

    ipUInt64                getMaxNbElements() const;

    ipUInt64                merge(const ElementsLocationInfo& elementsLocationInfo);

    void                    clearDataLocalization();

    void                    clear();

protected:
    ipUInt64                insertElements(const ElementsRange& elementsRange,
                                           const GuidSet& guidSet,
                                           const ipUInt64 dataMemorySize,
                                           const bool bAllowExtension);

// attributes
protected:
    ElementsLocation            _elementsLocations;

    ipUInt64                    _startOffset;

    ipUInt64                    _nbElements;

    bool                        _bHasLocalData;

    bool                        _bHasRemoteData;

    GuidSet                     _remoteLocations;

    ipUInt64                    _fullDataMemorySize;
};


inline ipUInt64
ElementsLocationInfo::getStartOffset() const
{
    return _startOffset;
}

inline ipUInt64
ElementsLocationInfo::getNbElements() const
{
    return _nbElements;
}

inline bool
ElementsLocationInfo::areDataLocalized() const
{
    return (_bHasLocalData == true) || (_bHasRemoteData == true);
}

inline bool
ElementsLocationInfo::hasLocalData() const
{
    return _bHasLocalData;
}

inline bool
ElementsLocationInfo::hasRemoteData() const
{
    return _bHasRemoteData;
}

inline ipUInt64
ElementsLocationInfo::getFullDataMemorySize() const
{
    return _fullDataMemorySize;
}

inline const GuidSet&
ElementsLocationInfo::getRemoteLocations() const
{
    return _remoteLocations;
}

inline const ElementsLocation&
ElementsLocationInfo::getElementsLocation() const
{
    return _elementsLocations;
}


} // end of namespace processor
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEPROCESSING_ELEMENTSLOCATIONINFO_H__