LogManager.h

Go to the documentation of this file.

#pragma once
#include <NDEVR/Dictionary.h>
#include <NDEVR/String.h>
#include <NDEVR/Log.h>
#include <NDEVR/BinaryFile.h>
namespace NDEVR
{
    class AsciiFileOutputStream;
    /**--------------------------------------------------------------------------------------------------
    \brief A class that has any number of children that also feed into the log. Can be used to easily
        collect logs from a variaty of different streams.
    **/
    class NDEVR_BASE_API LogManager : public ProgressInfo
    {
    public:
        enum MoveMode
        {
              e_move
            , e_copy
            , e_ignore
        };
        bool hasLog(const String& log_name) const;
        ProgressInfo* getLog(const String& log_name) const;
        ProgressInfo* defaultLog() const
        {
            return getLog("DEFAULT");
        }
        void writeToFile(BinaryFile& file, uint01 minimum_log_level, CompressionMode mode = CompressionMode::e_default_compression);
        void addStream(LogStream* stream, bool add_all) override;
        void addLog(const String& name, ProgressInfo* info);
        void removeStream(LogStream* stream) override;
        void setDefaultAsciiLogPath(const File& file, MoveMode mode);
        virtual bool setProgress(fltp04) override;
        virtual void allowCancel(bool) override;
        const Dictionary<String, ProgressInfo*>& logs();
        virtual bool addMessage(const TranslatedString&, uint01 = 10) override;
        virtual bool addMessage(const LogMessage&) override;
        virtual bool addMessage(const String&, uint01 = 10) override;
        virtual bool addMessage(const char* const, uint01 = 10) override;
        void logStartupInformation(const String& log) const;
        virtual void setCancelRequest(bool) override;
        void readFromFile(BinaryFile& file);
        mutable Dictionary<String, ProgressInfo*> m_logs;
        Buffer<LogStream*> m_streams;
        Dictionary<String, AsciiFileOutputStream*> m_ascii_streams;
        File m_default_ascii_log_path;
    };
}