FMTLogger.h

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Qu�bec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTlogger_Hm_included
#define FMTlogger_Hm_included
#include <boost/serialization/export.hpp>
#include <boost/thread/recursive_mutex.hpp>
#include <fstream>
#include <string>
#include <memory>
#include "FMTException.h"
 
namespace boost
{
    namespace serialization
    {
        class access;
    }
}
 
 
namespace Logging
{
    class FMTSolverLogger;
    //class CoinMessageHandler;
    // DocString: FMTLogger 
    class FMTEXPORT FMTLogger
        {
        public:
            // DocString: FMTLogger()
            FMTLogger();
            // DocString: ~FMTLogger()
            virtual ~FMTLogger();
            // DocString: FMTLogger(const FMTLogger&)
            FMTLogger(const FMTLogger& rhs);
            // DocString: FMTLogger::redirectToFile
            void redirectToFile(const std::string& filename, bool logStamp = true);
            // DocString: FMTLogger::closeFileStream
            void closeFileStream();
            // DocString: FMTLogger::operator=
            FMTLogger& operator = (const FMTLogger& rhs);
            #ifdef FMTWITHOSI
                // DocString: FMTLogger::print
                virtual int print();
                // DocString: FMTLogger::checkSeverity
                virtual void checkSeverity();
                // DocString: FMTLogger::clone
                virtual FMTLogger* clone() const=0;
            #endif
            // DocString: FMTLogger::getLogStamp
            virtual std::string getLogStamp() const;
            // DocString: FMTLogger::logStamp
            virtual void logStamp();
            // DocString: FMTLogger::logTime
            virtual void logTime();
            // DocString: FMTLogger::setStreamFlush
            void setStreamFlush(bool flush);
            // DocString: FMTLogger::operator<<(const std::string& msg)
            virtual FMTLogger& operator<<(const std::string& msg);
            // DocString: FMTLogger::operator<<(const int& msg)
            virtual FMTLogger& operator<<(const int& msg);
            // DocString: FMTLogger::operator<<(const double& msg)
            virtual FMTLogger& operator<<(const double& msg);
            // DocString: FMTLogger::operator<<(const float& msg)
            virtual FMTLogger& operator<<(const float& msg);
            // DocString: FMTLogger::operator<<(const std::time_t& msg)
            virtual FMTLogger& operator<<(const std::time_t& msg);
            // DocString: FMTLogger::operator<<(const size_t& msg)
            virtual FMTLogger& operator<<(const size_t& msg);
            // DocString: FMTLogger::operator<<(const unsigned int& msg)
            virtual FMTLogger& operator<<(const unsigned int& msg);
            // DocString: FMTLogger::operator<<(const void*& msg)
            virtual FMTLogger& operator<<(const void*& msg);
            // DocString: FMTLogger::logWithLevel
            virtual bool logWithLevel(const std::string& p_msg, const int& p_messageLevel) const;
            #ifdef FMTWITHOSI
            // DocString: FMTLogger::getSolverLogger
            virtual FMTSolverLogger* getSolverLogger();
            #endif
            // DocString: FMTLogger::Clone
            virtual std::unique_ptr <FMTLogger> Clone() const = 0;
        protected:
            #if defined FMTWITHOSI
            std::unique_ptr<FMTSolverLogger>m_solverref;
            #endif
            // DocString: FMTLogger::pathtostream
            std::string m_filepath;
            // DocString: FMTLogger::m_FileStream
            mutable std::unique_ptr<std::ofstream>m_FileStream;
            // DocString: FMTLogger::m_mtx
            //mutable std::recursive_mutex mtx;
            mutable boost::recursive_mutex m_mtx;
            // DocString: FMTLogger::m_flushstream
            bool m_flushstream;
            // DocString: FMTLogger::_cout
            virtual void _cout(const char* message) const;
            #ifdef FMTWITHOSI
            // DocString: FMTLogger::_setLoggingLevel
            virtual void _setLoggingLevel(const int& level);
            #endif // FMTWITHOSI
        private:
            friend class boost::serialization::access;
            // DocString: FMTLogger::save
            template<class Archive>
            void save(Archive& ar, const unsigned int version) const;
            // DocString: FMTLogger::load
            template<class Archive>
            void load(Archive& ar, const unsigned int version);
            // DocString: FMTLogger::serialize
            template<class Archive>
            void serialize(Archive& ar, const unsigned int file_version);
            // DocString: FMTLogger::_setToFile
            void _setToFile(const std::string& filename) const;
            
        };
 
}
 
BOOST_CLASS_EXPORT_KEY(Logging::FMTLogger)
 
#endif