history.h

Go to the documentation of this file.

/*
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Sascha Korf, Rene Schmieding
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MIO_IO_HISTORY_H
#define MIO_IO_HISTORY_H
 
#include "memilio/utils/metaprogramming.h"
#include <vector>
#include <tuple>
 
namespace mio
{
 
template <class... Loggers>
struct DataWriterToMemory {
    using Data = std::tuple<std::vector<typename Loggers::Type>...>;
    template <class Logger>
    static void add_record(const typename Logger::Type& t, Data& data)
    {
        std::get<mio::index_of_type_v<Logger, Loggers...>>(data).push_back(t);
    }
};
 
template <template <class... /*Loggers*/> class Writer, class... Loggers>
class History
{
    static_assert(!has_duplicates_v<Loggers...>, "The Loggers used for a History must be unique.");
 
public:
    using WriteWrapper = Writer<Loggers...>;
 
    History() = default;
 
    History(typename WriteWrapper::Data data)
        : m_data(data)
    {
    }
 
    History(typename Loggers::Type... args)
        : m_data(std::tie(args...))
    {
    }
 
    template <class T>
    void log(const T& t)
    {
        (log_impl(t, std::get<index_of_type_v<Loggers, Loggers...>>(m_loggers)), ...);
    }
 
    const typename WriteWrapper::Data& get_log() const
    {
        return m_data;
    }
 
private:
    typename WriteWrapper::Data m_data;
    std::tuple<Loggers...> m_loggers;
 
    template <class T, class Logger>
    void log_impl(const T& t, Logger& logger)
    {
        if (logger.should_log(t)) {
            WriteWrapper::template add_record<Logger>(logger.log(t), m_data);
        }
    }
};
 
template <class... Loggers>
using HistoryWithMemoryWriter = History<DataWriterToMemory, Loggers...>;
 
struct LogOnce {
    bool was_logged = false; 
 
    template <class T>
    bool should_log(const T&)
    {
        return was_logged ? false : (was_logged = true);
    }
};
 
struct LogAlways {
    template <class T>
    constexpr bool should_log(const T&)
    {
        return true;
    }
};
} // namespace mio
 
#endif // MIO_IO_HISTORY_H