Binary.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   Binary.h
//  AUTHOR      :   Yuxiao Xiao
//  CREATION    :   8/24/01
//  Copyright (C) MicroStrategy, Inc. 2001
//==============================================================================================
#ifndef MDataType_Binary_h
#define MDataType_Binary_h

#include "DataType.h"
#include "Base/Defines/StrongPtr.h"
#include "Base/Defines/ReturnPtr.h"
#include "PDCtypes.h"

namespace MBase
{
    class Buffer;
}

namespace MDataType
{

    class Binary
    {
    public:
        
        // a virtual destructor is a must
        virtual ~Binary() throw()
        {
        }

        typedef MBase::StrongPtr<Binary> Ptr;
        typedef MBase::ReturnPtr<Binary> ReturnPtr;


        virtual void SetBinary(const void* ipData, size_t iSize) = 0;


        virtual bool operator == (const Binary& irBinary) const = 0;

        virtual bool operator < (const Binary& irBinary) const = 0;

        virtual size_t GetSize() const = 0;

        virtual const void* c_ptr() const = 0;

        virtual void ZapTail(size_t iHowManyBytes) = 0;

        virtual void ZapHead(size_t iHowManyBytes) = 0;

        virtual void UnZap() = 0;

        virtual char* GiveUpBinary() = 0;
    };

    // this typedef is obsolete, use Binary::Ptr instead
    typedef MBase::StrongPtr<Binary> BinaryPtr;


    DLL_DATATYPE_EXIM Binary* CreateBinary(MBase::Buffer* ipBuffer = NULL);


    DLL_DATATYPE_EXIM Binary* CreateBinary(const void* ipData, size_t iSize, MBase::Buffer* ipBuffer = NULL);


    DLL_DATATYPE_EXIM Binary* CreateBinary(size_t iSize, MBase::Buffer* ipBuffer = NULL);
}

#endif // MDataType_Binary_h