fbxstream.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_CORE_STREAM_H_
#define _FBXSDK_CORE_STREAM_H_

#include <fbxsdk/fbxsdk_def.h>
#include <fbxsdk/core/base/fbxfile.h>
#include <fbxsdk/core/arch/fbxtypes.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxStream
{
public:
    enum EState {eClosed, eOpen, eEmpty};

    FbxStream() {};

    virtual ~FbxStream() {};

    virtual EState GetState() = 0;

    virtual bool Open( void* pStreamData ) = 0;

    virtual bool Close() = 0;

    virtual bool Flush() = 0;

    virtual int Write(const void* /*pData*/, int /*pSize*/) = 0;

    virtual int Read(void* /*pData*/, int /*pSize*/) const = 0;

    virtual char* ReadString(char* pBuffer, int pMaxSize, bool pStopAtFirstWhiteSpace=false);

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    int Write(const char* pData, int pSize){ return Write((void*)pData, pSize); }
    int Write(const int* pData, int pSize){ return Write((void*)pData, pSize); }
    int Read(char* pData, int pSize) const { return Read((void*)pData, pSize); }
    int Read(int* pData, int pSize) const { return Read((void*)pData, pSize); }
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

    virtual int GetReaderID() const = 0;

    virtual int GetWriterID() const = 0;

    virtual void Seek(const FbxInt64& pOffset, const FbxFile::ESeekPos& pSeekPos)=0;

    virtual long GetPosition() const = 0;

    virtual void SetPosition(long pPosition)=0;

    virtual int GetError() const = 0;

    virtual void ClearError() = 0;
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_STREAM_H_ */