ReadBlockStream.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   ReadBlockStream.h
//  AUTHOR      :   Yi Luo
//  PROJECT     :   PDSerialization
//
//  CREATION    :   2002-07-15
//  Copyright (C) MicroStrategy, Inc. 2002
//==============================================================================================
#ifndef Serialization_ReadBlockStream_H
#define Serialization_ReadBlockStream_H

#include "PDSerialization.h"
#include "DataType/DataType/Binary.h"
#include "PDSerialization/PDSerialization/ReadDataStream.h"

namespace MSerialization
{
    class WriteBlockStream;

    class DLL_PDSERIALIZATION_EXIM ReadListStream: public ReadDataStream
    {
    public:

        virtual void StartReadList()=0;

        virtual bool MoreElement() throw() =0;

    protected:
        virtual ~ReadListStream(){};

    };


    class DLL_PDSERIALIZATION_EXIM ReadBlockStream: public ReadListStream
    {
    public:

        virtual unsigned short ReadBlockHeader()=0;

        virtual void FinishReadBlock()=0;

        virtual bool MoreDataInBlock()=0;


    protected:
        virtual ~ReadBlockStream(){};

    };

    class DLL_PDSERIALIZATION_EXIM AutoReadBlockStreamCloser
    {
    public:
        AutoReadBlockStreamCloser(ReadBlockStream* ipReadStream);
        ~AutoReadBlockStreamCloser() throw();

    private:
        // pointer to the ReadBlockStream
        ReadBlockStream* mpReadStream;
    };


    typedef MBase::StrongPtr<ReadBlockStream, MBase::DeleteOperatorGeneric<ReadBlockStream> > ReadBlockStreamPtr;

    // factory function to create a ReadBlockStream from a Binary.

    DLL_PDSERIALIZATION_EXIM ReadBlockStream * ConvertBinary2ReadBlockStream(MDataType::Binary * ipBinary,
                                                                             MBase::MemoryContract * ipMemCon = 0);

    DLL_PDSERIALIZATION_EXIM ReadBlockStream * ConvertBinaryCollection2ReadBlockStream(MDataType::BinaryCollection * ipBinaryCol,
                                                                             MBase::MemoryContract * ipMemCon = 0);

    DLL_PDSERIALIZATION_EXIM ReadBlockStream * ConvertWriteBlockStream2ReadBlockStream(
                                                    WriteBlockStream* ipWriteStream, MBase::MemoryContract * ipMemCon = 0);

    DLL_PDSERIALIZATION_EXIM ReadBlockStream* GetReadBlockStreamFromFile(MFileSystem::ReadableFile::Ptr& iFilePtr);
}

#endif // Serialization_ReadBlockStream_H