LogBackend.hpp

Go to the documentation of this file.

/*
  Copyright 2015, 2016 Statoil ASA.
  Copyright 2016 SINTEF ICT, Applied Mathematics.
 
  This file is part of the Open Porous Media project (OPM).
 
  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef OPM_LOGBACKEND_HPP
#define OPM_LOGBACKEND_HPP
 
#include <opm/common/OpmLog/MessageFormatter.hpp>
#include <opm/common/OpmLog/MessageLimiter.hpp>
#include <cstdint>
#include <string>
#include <memory>
 
namespace Opm
{
 
    class LogBackend
    {
    public:
        explicit LogBackend(int64_t mask);
 
        virtual ~LogBackend();
 
        void setMessageFormatter(std::shared_ptr<MessageFormatterInterface> formatter);
 
        void setMessageLimiter(std::shared_ptr<MessageLimiter> limiter);
 
        void addMessage(int64_t messageFlag, const std::string& message);
 
        void addTaggedMessage(int64_t messageFlag,
                              const std::string& messageTag,
                              const std::string& message);
 
        int64_t getMask() const;
 
    protected:
        virtual void addMessageUnconditionally(int64_t messageFlag,
                                               const std::string& message) = 0;
 
        std::string formatMessage(int64_t messageFlag, const std::string& message);
 
    private:
        bool includeMessage(int64_t messageFlag, const std::string& messageTag);
 
        int64_t m_mask;
        std::shared_ptr<MessageFormatterInterface> m_formatter;
        std::shared_ptr<MessageLimiter> m_limiter;
    };
 
} // namespace LogBackend
 
 
#endif