FBX_ErrorManager.h

Go to the documentation of this file.

/*
* PROPRIETARY INFORMATION.  This software is proprietary to
* Side Effects Software Inc., and is not to be reproduced,
* transmitted, or disclosed in any way without written permission.
*
* NAME: FBX_ErrorManager.h (FBX Library, C++)
*
* COMMENTS:     
*
*/

#ifndef __FBX_ErrorManager_h__
#define __FBX_ErrorManager_h__

#include "FBX_API.h"

#include <UT/UT_Array.h>
#include <UT/UT_StringHolder.h>

class UT_WorkBuffer;

enum FBX_ErrorType
{
    FBX_ErrorGeneric = 0,
    FBX_ErrorIncorrectPassword,
    FBX_ErrorLights
};

class FBX_API FBX_Error
{
public:
    FBX_Error(const UT_StringHolder &pMessage, bool bIsCritical, FBX_ErrorType eType);
    virtual ~FBX_Error();

    bool getIsCritical() const;
    const UT_StringHolder &getMessage() const;
    FBX_ErrorType getType() const;

private:
    UT_StringHolder myMessage;
    bool myIsCritical;
    FBX_ErrorType myType;
};

class FBX_API FBX_ErrorManager
{
public:
    FBX_ErrorManager();
    virtual ~FBX_ErrorManager();

    void addError(const UT_StringHolder &pcsError, bool bIsCritical = true, FBX_ErrorType eType = FBX_ErrorGeneric);
    void addWarning(const UT_StringRef &msg,
                    FBX_ErrorType type = FBX_ErrorGeneric);
    void addError(const char* pcsErrorPart1, const char* pcsErrorPart2, const char* pcsErrorPart3, bool bIsCritical = true, FBX_ErrorType eType = FBX_ErrorGeneric);

    int getNumItems() const;

    bool getDidReportCriticalErrors() const;

    void reset();

    void appendAllErrors(UT_WorkBuffer &string_out) const;
    void appendAllWarnings(UT_WorkBuffer &string_out) const;

private:
    UT_Array<FBX_Error> myErrors;
    bool myDidReportCricialErrors;
};

#endif // __FBX_ErrorManager_h__