Create small utility class InfoLogger

This commit is contained in:
Joakim Hove
2020-10-15 16:15:56 +02:00
parent d9f260dd51
commit 9c49468f46
3 changed files with 92 additions and 0 deletions

View File

@@ -27,6 +27,7 @@ list (APPEND MAIN_SOURCE_FILES
src/opm/common/OpmLog/Logger.cpp
src/opm/common/OpmLog/LogUtil.cpp
src/opm/common/OpmLog/KeywordLocation.cpp
src/opm/common/OpmLog/InfoLogger.cpp
src/opm/common/OpmLog/OpmLog.cpp
src/opm/common/OpmLog/StreamLog.cpp
src/opm/common/OpmLog/TimerLog.cpp
@@ -516,6 +517,7 @@ list( APPEND PUBLIC_HEADER_FILES
opm/common/OpmLog/MessageFormatter.hpp
opm/common/OpmLog/MessageLimiter.hpp
opm/common/OpmLog/KeywordLocation.hpp
opm/common/OpmLog/InfoLogger.hpp
opm/common/OpmLog/OpmLog.hpp
opm/common/OpmLog/StreamLog.hpp
opm/common/OpmLog/TimerLog.hpp

View File

@@ -0,0 +1,47 @@
/*
Copyright 2020 Statoil ASA.
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 INFO_LOGGER_HPP
#define INFO_LOGGER_HPP
#include <cstddef>
#include <string>
namespace Opm {
/*
A small utility class to use in the situation where the first N messages
should go to OpmLog::info() and then the subsequent messages should go to
OpmLog::note()
*/
class InfoLogger {
public:
InfoLogger(const std::string& context_arg, std::size_t info_limit);
void operator()(const std::string& msg);
private:
std::string context;
std::size_t info_limit;
std::size_t info_count=0;
void (*log_function)(const std::string&);
};
}
#endif

View File

@@ -0,0 +1,43 @@
/*
Copyright 2020 Statoil ASA.
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/>.
*/
#include <fmt/format.h>
#include <opm/common/OpmLog/InfoLogger.hpp>
#include <opm/common/OpmLog/OpmLog.hpp>
namespace Opm {
InfoLogger::InfoLogger(const std::string& context_arg, std::size_t info_limit_arg):
context(context_arg),
info_limit(info_limit_arg)
{
this->log_function = &OpmLog::info;
}
void InfoLogger::operator()(const std::string& msg) {
if (this->info_count == this->info_limit) {
OpmLog::info(fmt::format("Reporting limit reached for {} - see PRT file for additional messages", this->context));
this->log_function = &OpmLog::note;
}
this->log_function(msg);
this->info_count += 1;
}
}