FMTlogger.hpp

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_H_INCLUDED
#define FMTlogger_H_INCLUDED
#include <boost/serialization/export.hpp>
#include <boost/thread/recursive_mutex.hpp>
#include <fstream>
#include <string>
#include "FMTexception.hpp"
 
namespace boost
{
    namespace serialization
    {
        class access;
    }
}
 
 
namespace Logging
{
    class FMTsolverlogger;
    //class CoinMessageHandler;
    // DocString: FMTlogger 
    class FMTEXPORT FMTlogger
        {
        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;
        protected:
        #if defined FMTWITHOSI
            std::unique_ptr<FMTsolverlogger>solverref;
        #endif
            // DocString: FMTlogger::pathtostream
            std::string filepath;
            // DocString: FMTlogger::filestream
            mutable std::ofstream* filestream;
            // DocString: FMTlogger::mtx
            //mutable std::recursive_mutex mtx;
            mutable boost::recursive_mutex mtx;
            // DocString: FMTlogger::flushstream
            bool flushstream;
            // DocString: FMTlogger::cout
            virtual void cout(const char* message) const;
            #ifdef FMTWITHOSI
                // DocString: FMTlogger::setlogginglevel
                virtual void setlogginglevel(const int& level);
            #endif // FMTWITHOSI
        public:
            // DocString: FMTlogger()
            FMTlogger();
            // DocString: ~FMTlogger()
            virtual ~FMTlogger();
            // DocString: FMTlogger(const FMTlogger&)
            FMTlogger(const FMTlogger& rhs);
            // DocString: FMTlogger::redirectofile
            void redirectofile(const std::string& filename);
            // 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;
            #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::logwithlevel
            virtual bool logwithlevel(const std::string &msg, const int& messagelevel) const;
            #ifdef FMTWITHOSI
            // DocString: FMTlogger::getsolverlogger
            virtual FMTsolverlogger* getsolverlogger();
            #endif
            
        };
 
}
 
BOOST_CLASS_EXPORT_KEY(Logging::FMTlogger)
 
#endif