BaseFragBuffer.h

// BaseFragBuffer.h:
// -----------------
//

#ifndef __IPSDKBASEDATA_BASEFRAGBUFFER_H__
#define __IPSDKBASEDATA_BASEFRAGBUFFER_H__

// suppression warnings
// warning C4251: 'ipsdk::BaseFragBuffer::_bufferPtrColl' : class 'std::vector<_Ty>' needs to have dll-interface to be used by clients of class 'ipsdk::BaseFragBuffer'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKBaseData/Buffer/BaseBuffer.h>
#include <vector>

namespace ipsdk {


class IPSDKBASEDATA_API BaseFragBuffer : public BaseBuffer
{
    // declare dynamic class
    IPSDK_DECLARE_ABSTRACT_DYNAMIC_WITHOUT_COPY(IPSDKBaseData, BaseFragBuffer)

public:
    BaseFragBuffer();
    virtual ~BaseFragBuffer() = 0;
    
// methods
public:
    ipUInt64                getNbFragments() const;

    ipUInt64                getFragmentsSize() const;

    const BufferPtrColl&    getBufferPtrColl() const;

    const void*             getDataPtr(const ipUInt64 fragmentIndex) const;
    void*                   getDataPtr(const ipUInt64 fragmentIndex);

    const void*             getDataPtr(const ipUInt64 fragmentIndex,
                                       const ipUInt64 offset) const;
    void*                   getDataPtr(const ipUInt64 fragmentIndex,
                                       const ipUInt64 offset);

    void                    rollUpFragments();

    void                    rollDownFragments();


protected:
    void            initBase(const eDataType& dataType,
                             const BufferPtrColl& bufferPtrColl,
                             const ipUInt64 fragmentsSize);

    void            setDataPtr(const ipUInt64 fragmentIndex,
                               void* pData);

    virtual void    clearDerived();

// attributes
private:
    BufferPtrColl       _bufferPtrColl;

    ipUInt64            _fragmentsSize;
};


} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEDATA_BASEFRAGBUFFER_H__