fbxstream.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2015 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/fbxsdk_nsbegin.h>

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

    virtual EState GetState() = 0;

    virtual bool Open(void* pStreamData) = 0;

    virtual bool Close() = 0;

    virtual bool Flush() = 0;

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

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

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

    virtual int GetReaderID() const = 0;

    virtual int GetWriterID() const = 0;

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

    virtual FbxInt64 GetPosition() const = 0;

    virtual void SetPosition(FbxInt64 pPosition)=0;

    virtual int GetError() const = 0;

    virtual void ClearError() = 0;

/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    FbxStream(){};
    virtual ~FbxStream(){};

    size_t Write(const char* pData, FbxUInt64 pSize){ return Write((void*)pData, pSize); }
    size_t Write(const int* pData, FbxUInt64 pSize){ return Write((void*)pData, pSize); }
    size_t Read(char* pData, FbxUInt64 pSize) const { return Read((void*)pData, pSize); }
    size_t Read(int* pData, FbxUInt64 pSize) const { return Read((void*)pData, pSize); }
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_STREAM_H_ */