fbxstatus.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2016 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_BASE_STATUS_H_
#define _FBXSDK_CORE_BASE_STATUS_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/core/base/fbxarray.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxStatus
{
public:


    enum EStatusCode {        
        eSuccess = 0,                           
        eFailure,                               
        eInsufficientMemory,                    
        eInvalidParameter,                      
        eIndexOutOfRange,                       
        ePasswordError,                         
        eInvalidFileVersion,                    
        eInvalidFile,                           
        eSceneCheckFail                         
    };

    FbxStatus();
    FbxStatus(EStatusCode pCode);
    FbxStatus(const FbxStatus& rhs);

    ~FbxStatus();

    FbxStatus&      operator=(const FbxStatus& rhs);
    FbxStatus&      operator+=(const FbxStatus& rhs);

    bool            operator==(const FbxStatus& rhs)    const   { return (mCode == rhs.mCode); }
    bool            operator==(const EStatusCode pCode) const   { return (mCode == pCode); }
    bool            operator!=(const FbxStatus& rhs)    const   { return (mCode != rhs.mCode); }
    bool            operator!=(const EStatusCode rhs)   const   { return (mCode != rhs); }

    operator        bool() const    { return mCode==eSuccess; }

    bool            Error() const   { return !this->operator bool(); }

    void            Clear();

    EStatusCode     GetCode() const { return mCode; }

    void            SetCode(const EStatusCode rhs);

    void            SetCode(const EStatusCode rhs, const char* pErrorMsg, ...);

    const char*     GetErrorString() const;

    bool            KeepErrorStringHistory(bool pState);

    void            GetErrorStringHistory(FbxArray<FbxString*>& pHistory);

/*****************************************************************************************************************************
** 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

private:
    EStatusCode     mCode;
    FbxString       mErrorString;
    bool            mKeepErrorStringHistory;

    FbxArray<FbxString*> mErrorStringHistory;
#endif /* !DOXYGEN_SHOULD_SKIP_THIS */
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_BASE_STATUS_H_ */