dtk_log.hpp

Go to the documentation of this file.

#ifndef _DTK_LOG_HPP_
#define _DTK_LOG_HPP_
#include "def/define.h"
#include "dtk_maindoc_ptr.hpp"
#include "util/BaseTypes/dtk_object.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/error_dtk.hpp"
#include "util/util_stl_dtk.hpp"
 
class Dtk_Log;
typedef Dtk_SmartPtr<Dtk_Log> Dtk_LogPtr;
 
class Dtk_Log_Inventory 
{
protected:
    struct Dtk_Handle;      // Not defined here
    Dtk_Handle *_Private;   // Handle
     friend class Dtk_SmartPtr<Dtk_Log>;
 
public:
    Dtk_Log_Inventory();
    Dtk_Log_Inventory(const Dtk_Log_Inventory& inInventory);
    ~Dtk_Log_Inventory();
    Dtk_Log_Inventory& operator=(const Dtk_Log_Inventory& inInventory);
 
    Dtk_Size_t GetTotalCount();
 
    Dtk_Size_t GetNbEntityTypes();
 
    const Dtk_string & GetEntityType(Dtk_Size_t inIndex);
 
    int GetEntitiesCount(Dtk_Size_t inIndex);
 
    // must only be called to fill inventory
    void AddEntity(int inCount, const Dtk_string& inName);
};
 
class Dtk_Log_Message 
{
protected:
    struct Dtk_Handle;      // Not defined here
    Dtk_Handle *_Private;   // Handle
 
public:
    Dtk_Log_Message();
    Dtk_Log_Message(const Dtk_Log_Message& inMessage);
    ~Dtk_Log_Message();
    Dtk_Log_Message& operator=(const Dtk_Log_Message& inMessage);
 
    const Dtk_string & GetType() const;
 
    const Dtk_string & GetMessageInfo() const;
 
    void SetType(const Dtk_string& inValue);
 
    void SetMessageInfo(const Dtk_string& inValue);
};
 
class Dtk_Log_Component_Info 
{
protected:
    struct Dtk_Handle;      // Not defined here
    Dtk_Handle *_Private;   // Handle
 
public:
    Dtk_Log_Component_Info();
    Dtk_Log_Component_Info(const Dtk_Log_Component_Info& inComponentInfo);
    ~Dtk_Log_Component_Info();
    Dtk_Log_Component_Info& operator=(const Dtk_Log_Component_Info& inComponentInfo);
 
     Dtk_bool GetIsCatalog() const;
 
    Dtk_bool GetIsAssembly() const;
 
    Dtk_bool GetIsInternal() const;
 
    const Dtk_string & GetName() const;
 
    const Dtk_string & GetFullPathName() const;
 
    int GetQuantity() const;
 
    long GetFileSize() const;
 
    Dtk_Double64 GetUnitScale() const;
 
    const Dtk_string & GetFileVersion() const;
 
    const Dtk_string & GetPath();
 
     void SetIsCatalog(Dtk_bool val);
 
    void SetIsAssembly(Dtk_bool val);
 
    void SetIsInternal(Dtk_bool val);
 
    void SetName(const Dtk_string& val);
 
    void SetFullPathName(const Dtk_string& val); 
 
    void SetQuantity(int val); 
 
    void SetFileSize(long val);
 
    void SetUnitScale(Dtk_Double64 val); 
 
    void SetFileVersion(const Dtk_string& val);
};
 
class Dtk_Log : public Dtk_Object
{
protected:
    struct Dtk_Handle;      // Not defined here
    Dtk_Handle *_Private;   // Handle
     enum { _typeID = DTK_TYPE_LOG };
 
private :
     //void _Init();
     //void _Copy(const Dtk_Log& s);
     //void _Reset();
     friend class Dtk_SmartPtr<Dtk_Log>;
 
public:
    Dtk_Log();
    virtual ~Dtk_Log();
 
     static Dtk_LogPtr Create();
     int DtkDynamicType(const int& inId);
     static Dtk_Log * DtkDynamicCast(Dtk_Object * inObject);
 
    const Dtk_string & GetLogFileName() const;
 
    int GetAPIVersion() const;
 
    const Dtk_string & GetProductMode() const;
 
    const Dtk_string & GetInputFormat() const;
 
    const Dtk_string & GetOutputFormat() const;
 
    int GetHealingFlag() const;
 
    const Dtk_string & GetConfigFileName() const;
 
    const Dtk_string & GetInputFileName() const;
 
    const Dtk_string & GetInputFileVersion() const;
 
    const Dtk_string & GetOutputFileName() const;
 
    long GetOutputFileSize() const;
 
    double GetUnitScale() const;
 
    time_t GetStartTime() const;
 
    time_t GetStopTime() const;
 
     const Dtk_string & GetStartHour() const;
 
     const Dtk_string & GetStopHour() const;
 
    double GetCPUTime() const;
 
    double GetWallTime() const;
 
     Dtk_UInt64 GetPeakWorkingSetSize() const;
 
     Dtk_UInt64 GetWorkingSetSize() const;
 
    const Dtk_string & GetXslSchemaName() const;
 
    const Dtk_string & GetXslFolder() const;
 
    Dtk_string GetXslFilePath() const;
 
     Dtk_bool GetIsCrash();
 
    Dtk_Size_t GetNbConfigSections();
 
    Dtk_ErrorStatus GetConfigSection(Dtk_Size_t inIndex, Dtk_string& outName, Dtk_tab<Dtk_string>& outParameters, Dtk_tab<Dtk_string>& outValues);
    
    Dtk_ErrorStatus GetListComponentID(Dtk_tab<Dtk_ID>& outListID);
 
    Dtk_ErrorStatus GetComponentInfo(Dtk_Size_t inComponentID, Dtk_Log_Component_Info& outComponentInfo);
 
    Dtk_ErrorStatus GetComponentReadingErrorStatus(Dtk_Size_t inComponentID, Dtk_ErrorStatus& outReadingErrorStatus);
 
    Dtk_ErrorStatus GetComponentInventory(Dtk_Size_t inComponentID, Dtk_Log_Inventory& outInventory);
 
    Dtk_ErrorStatus GetComponentSyntheticInventory(Dtk_Size_t inComponentID, Dtk_Log_Inventory& outInventory);
 
    Dtk_ErrorStatus GetComponentWarningMessages(Dtk_Size_t inComponentID, Dtk_tab<Dtk_Log_Message>& outMessages);
 
    Dtk_ErrorStatus GetComponentErrorMessages(Dtk_Size_t inComponentID, Dtk_tab<Dtk_Log_Message>& outMessages);
 
    Dtk_ErrorStatus GetComponentInfoMessages(Dtk_Size_t inComponentID, Dtk_tab<Dtk_Log_Message>& outMessages);
 
    Dtk_ErrorStatus GetGlobalWarningMessages(Dtk_tab<Dtk_Log_Message>& outMessages);
 
    Dtk_ErrorStatus GetGlobalErrorMessages(Dtk_tab<Dtk_Log_Message>& outMessages);
 
    Dtk_ErrorStatus GetGlobalInfoMessages(Dtk_tab<Dtk_Log_Message>& outMessages);
 
    // only useful for reading
    Dtk_tab<Dtk_ID> GetListMissingComponents();
 
    // only useful for writing
    const Dtk_tab<Dtk_string> & GetOutputFileNamesWritten() const;
 
    Dtk_ErrorStatus GetOutputFileInventory(Dtk_string inFileName, Dtk_Log_Inventory& outInventory);
 
    Dtk_ErrorStatus GetOutputFileSyntheticInventory(Dtk_string inFileName, Dtk_Log_Inventory& outInventory);
 
    Dtk_Size_t GetNbOutputFileValidationProperties(const Dtk_string& inOutputFileName);
 
    Dtk_ErrorStatus GetOutputFileValidationProperty(const Dtk_string& inOutputFileName, Dtk_Size_t inIndex, Dtk_string &outEntityID, Dtk_string &outEntityType,
                Dtk_string &outValPropName, Dtk_string &outRead, Dtk_string &outComputed, Dtk_string &outGap, Dtk_string &outStatus);
 
    Dtk_Size_t GetNbValidationProperties(Dtk_Size_t inComponentID);
 
    Dtk_ErrorStatus GetValidationProperty(Dtk_Size_t inComponentID, Dtk_Size_t inIndex, Dtk_string &outEntityID, Dtk_string &outEntityType,
        Dtk_string &outValPropName, Dtk_string &outRead, Dtk_string &outComputed, Dtk_string &outGap, Dtk_string &outStatus);
 
    void SetLogFileName(const Dtk_string& inVal);
 
    void SetProductMode(const Dtk_string& inVal);
 
    void SetInputFormat(const Dtk_string& inVal);
 
    void SetOutputFormat(const Dtk_string& inVal);
 
    void SetHealingFlag(int inVal);
 
    void SetConfigFileName(const Dtk_string& inVal);
 
    void SetInputFileName(const Dtk_string& inVal);
 
    void SetInputFileVersion(const Dtk_string& inVal);
 
    void SetOutputFileName(const Dtk_string& inVal);
 
    void SetUnitScale(double inVal);
 
    void SetStartTime(time_t inVal);
 
    void SetStopTime(time_t inVal);
 
    void SetStartHour(Dtk_string inVal);
 
    void SetStopHour(Dtk_string inVal);
 
    void SetCPUTime(double inVal);
    
    void SetWallTime(double inVal);
 
    void SetPeakWorkingSetSize( Dtk_UInt64 inVal);
 
    void SetWorkingSetSize( Dtk_UInt64 inVal);
 
    void SetXslFolder(const Dtk_string& inVal);
 
     void SetIsCrash(Dtk_bool inVal);
 
     void SetIsXslEmbedded(Dtk_bool inVal);
 
    Dtk_ErrorStatus FillConfig();
 
    Dtk_ErrorStatus AssociateFileNames(const Dtk_string& inTemporaryFile, const Dtk_string& inFileName);
 
    Dtk_ErrorStatus AddReadingInventory(Dtk_ID inComponentID, int inNum, const int *inCount, const char **inEntitiesName);
 
     Dtk_ErrorStatus AddReadingEntity(Dtk_ID inComponentID, const char * inName, int inCount=1);
 
    Dtk_ErrorStatus AddSyntheticReadingInventory(Dtk_ID inComponentID, int inNum, int *inCount, char **inEntitiesName);
 
    Dtk_ErrorStatus AddWritingInventory(const Dtk_string& inOutputFileName, int inNum, int *inCount, char **inEntitiesName);
 
    Dtk_ErrorStatus AddSyntheticWritingInventory(const Dtk_string& inOutputFileName, int inNum, int *inCount, char **inEntitiesName);
 
    Dtk_ErrorStatus AddOutputFileNameWritten(const Dtk_string& inOutputFileName, Dtk_bool isRoot = DTK_FALSE);
 
    Dtk_ErrorStatus AddWarningMessage(const Dtk_string& inMessage, const Dtk_string& inType, int inComponentID = -1);
 
    Dtk_ErrorStatus AddErrorMessage(const Dtk_string& inMessage, const Dtk_string& inType, int inComponentID = -1);
 
    Dtk_ErrorStatus AddInfoMessage(const Dtk_string& inMessage, const Dtk_string& inType, int inComponentID = -1);
 
    Dtk_ErrorStatus AddComponentInfoAndReadingErrorStatus(const Dtk_ComponentPtr& inComponent, Dtk_ErrorStatus inStatus);
 
    Dtk_ErrorStatus AddFileInfoAndReadingErrorStatus(const Dtk_string& inInputFileName, Dtk_string inFileVersion, Dtk_bool inIsAssembly,
                                                     Dtk_Double64 inUnitScale, Dtk_ErrorStatus inStatus);
 
    Dtk_ErrorStatus AddValidationProperty(Dtk_Size_t inComponentID, const Dtk_string &inEntityID, const Dtk_string &inEntityType,
                                          const Dtk_string &inValPropName, const Dtk_string &inRead, const Dtk_string &inComputed,
                                          const Dtk_string &inGap, const Dtk_string &inStatus);
 
    Dtk_ErrorStatus AddOutputFileValidationProperty(const Dtk_string& inOutputFileName, const Dtk_string &inEntityID, const Dtk_string &inEntityType,
        const Dtk_string &inValPropName, const Dtk_string &inWrite);
 
    virtual Dtk_ErrorStatus Write();
 
    virtual Dtk_ErrorStatus Flush();
};
 
 
 
 
#endif