kfbxusernotification.h

Go to the documentation of this file.

/****************************************************************************************

   Copyright (C) 2010 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 FBXFILESDK_KFBXPLUGINS_KFBXUSERNOTIFICATION_H
#define FBXFILESDK_KFBXPLUGINS_KFBXUSERNOTIFICATION_H


#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/components/kbaselib/klib/karrayul.h>
#include <fbxfilesdk/components/kbaselib/klib/kstring.h>
#include <fbxfilesdk/components/kbaselib/klib/kset.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxMessageEmitter;
class KFbxNode;
class KFbxUserNotificationFilteredIterator;
class KFbxSdkManager;
class KFbxLogFile;

class KFBX_DLL AccumulatorEntry
{
public:
    enum AEClass {
        eAE_ERROR=1,    
        eAE_WARNING=2,  
        eAE_INFO=4,     
        eAE_ANY=7       
    };

    AccumulatorEntry(AEClass pAEClass, const KString& pName, const KString& pDescr, 
                     KString pDetail="", bool pMuteState=true);

    AccumulatorEntry(const AccumulatorEntry& pAE, bool pSkipDetails);

    ~AccumulatorEntry();

    AEClass GetClass() const;

    KString GetName() const;

    KString    GetDescription() const;

    int GetDetailsCount() const;

    const KString* GetDetail(int id) const;

    bool IsMuted() const;

private:
    friend class KFbxUserNotification;
    KArrayTemplate<KString*>& GetDetails();
    void Mute(bool pState);

    bool    mMute;
    AEClass mAEClass;
    KString mName;
    KString mDescr;
    KArrayTemplate<KString*> mDetails;
};


class KFBX_DLL KFbxUserNotification
{
public:
    static KFbxUserNotification* Create(KFbxSdkManager* pManager, 
                                        const KString& pLogFileName, 
                                        const KString& pSessionDescription);

    static void Destroy(KFbxSdkManager* pManager);

    KFbxUserNotification(KFbxSdkManager* pManager,
                         KString const& pLogFileName, 
                         KString const& pSessionDescription);

    virtual ~KFbxUserNotification();

    void InitAccumulator();

    void ClearAccumulator();

    enum AEid {
        eBINDPOSE_INVALIDOBJECT = 0x0000,
        eBINDPOSE_INVALIDROOT,
        eBINDPOSE_NOTALLANCESTORS_NODES,
        eBINDPOSE_NOTALLDEFORMING_NODES,
        eBINDPOSE_NOTALLANCESTORS_DEFNODES,
        eBINDPOSE_RELATIVEMATRIX,
        eFILE_IO_NOTIFICATION,       
        eFILE_IO_NOTIFICATION_MATERIAL,
        eFILE_IO_NOTIFICATION_DXF_NOT_SUPPORT_NURBS,
        eAE_START_ID                 
    };

    int AddEntry(const int pID, const KString& pName, const KString& pDescr, AccumulatorEntry::AEClass pClass=AccumulatorEntry::eAE_WARNING);

    int AddDetail(int pEntryId);

    int AddDetail(int pEntryId, KString pString);

    int AddDetail(int pEntryId, KFbxNode* pNode);

    int  GetNbEntries() const;

    const AccumulatorEntry* GetEntry(int pEntryId) const;

    const AccumulatorEntry* GetEntryAt(int pEntryIndex) const;

    int GetNbDetails() const;

    int GetDetail(int pDetailId, const AccumulatorEntry*& pAE) const;


    enum OutputSource {
        eACCUMULATOR_ENTRY,     
        eSEQUENCED_DETAILS      
    };

    bool Output(OutputSource pOutSrc=eACCUMULATOR_ENTRY, int pIndex = -1, bool pExtraDevicesOnly = false);

    bool OutputById(AEid pId, OutputSource pOutSrc=eACCUMULATOR_ENTRY, bool pExtraDevicesOnly = false);

    bool Output(const KString& pName, const KString& pDescr, AccumulatorEntry::AEClass pClass, bool pExtraDevicesOnly = false);

    bool Output(KFbxUserNotificationFilteredIterator& pAEFIter, bool pExtraDevicesOnly = false);

    void SetLogMessageEmitter(KFbxMessageEmitter * pLogMessageEmitter);

    virtual void GetLogFilePath(KString& pPath);
    
    inline KString GetLogFileName() { return mLogFileName; }

protected:
    class AESequence
    {
    public:
        AESequence(AccumulatorEntry* pAE, int pDetailId) :
            mAE(pAE),
            mDetailId(pDetailId)
            {
            };

        AccumulatorEntry* AE() { return mAE; }
        int DetailId() { return mDetailId; }

    private:
        AccumulatorEntry* mAE;
        int mDetailId;
    };

    friend class KFbxUserNotificationFilteredIterator;

    virtual bool PostTerminate();

    virtual void AccumulatorInit();

    virtual void AccumulatorClear();

    virtual void OpenExtraDevices();

    virtual bool SendToExtraDevices(bool pOutputNow, KArrayTemplate<AccumulatorEntry*>& pEntries);

    virtual bool SendToExtraDevices(bool pOutputNow, KArrayTemplate<AESequence*>& pAESequence);

    virtual bool SendToExtraDevices(bool pOutputNow, const AccumulatorEntry* pAccEntry, int pDetailId = -1);

    
    virtual void CloseExtraDevices();

    void ResetAccumulator();

    void ResetSequence();

    void SendToLog(OutputSource pOutSrc, int pId);

    void SendToLog(const AccumulatorEntry* pAccEntry, int pDetailId = -1);

private:
    KString mLogFileName;
    KString* mLog;
    KFbxLogFile* mLogFile;
    KFbxMessageEmitter* mLogMessageEmitter;

    bool mProperlyInitialized;
    KString mSessionDescription;
    bool mProperlyCleaned;

    KSet mAccuHT;                             // The set establish a relationship between an AccumulatorEntry and it's ID
    KArrayTemplate<AccumulatorEntry*> mAccu;  // The array defines the order the AccumulatorEntry objects have been 
                                              // added to the accumulator (calls to AddEntry)
                                              // Both structures share the same pointers.
    KArrayTemplate<AESequence*> mAESequence;
    KFbxSdkManager*             mSdkManager;
};

#if 0

class KFBX_DLL KFbxUserNotificationFILE : public KFbxUserNotification
{
public:

    KFbxUserNotificationFILE(KString pFileDevice, KString pLogFileName="", KString pSessionDescription="");
    virtual ~KFbxUserNotificationFILE();

    virtual void OpenExtraDevices();
    virtual bool SendToExtraDevices(bool pOutputNow, KArrayTemplate<AccumulatorEntry*>& pEntries);
    virtual bool SendToExtraDevices(bool pOutputNow, KArrayTemplate<AESequence*>& pAESequence);
    virtual bool SendToExtraDevices(bool pOutputNow, const AccumulatorEntry* pAccEntry, int pDetailId = -1);
    virtual void CloseExtraDevices();

private:
    KString mFileDevice;
    FILE* mFP;
    int   mUseStream;
};
#endif

class KFBX_DLL KFbxUserNotificationFilteredIterator
{
public:
    KFbxUserNotificationFilteredIterator(KFbxUserNotification& pAccumulator, 
            int pFilterClass,
            KFbxUserNotification::OutputSource pSrc = KFbxUserNotification::eSEQUENCED_DETAILS,
            bool pNoDetail = true);

    virtual ~KFbxUserNotificationFilteredIterator();

    int  GetNbItems() const;

    void Reset();

    AccumulatorEntry* const First();

    AccumulatorEntry* const Previous();

    AccumulatorEntry* const Next();

protected:
    // Called in the constructor.
    virtual void BuildFilteredList(KFbxUserNotification& pAccumulator);

    int                                    mIterator;
    int                                    mFilterClass;
    bool                                mNoDetail;
    KFbxUserNotification::OutputSource    mAccuSrcData;
    KArrayTemplate<AccumulatorEntry*>    mFilteredAE;
};


#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXUSERNOTIFICATION_H