output_channel.h

Go to the documentation of this file.

 
#pragma once
 
#include <knp/core/core.h>
#include <knp/core/impexp.h>
#include <knp/core/message_endpoint.h>
#include <knp/core/messaging/messaging.h>
 
#include <algorithm>
#include <utility>
#include <vector>
 
#include "output_converter.h"
 
 
namespace knp::framework::io::output
{
class KNP_DECLSPEC OutputChannel
{
public:
    OutputChannel(const core::UID &channel_uid, core::MessageEndpoint &&endpoint)
        : base_{channel_uid}, endpoint_(std::move(endpoint))
    {
    }
 
    OutputChannel(OutputChannel &&) = default;
 
public:
    [[nodiscard]] const auto &get_uid() const { return base_.uid_; }
    [[nodiscard]] auto &get_tags() { return base_.tags_; }
 
public:
    std::vector<core::messaging::SpikeMessage> update();
 
    std::vector<core::messaging::SpikeMessage> read_some_from_buffer(core::Step starting_step, core::Step final_step);
 
protected:
    core::BaseData base_;
 
    core::MessageEndpoint endpoint_;
 
    std::vector<core::messaging::SpikeMessage> message_buffer_;  // cppcheck-suppress unusedStructMember
};
 
 
template <typename ResultType>
[[nodiscard]] ResultType output_channel_get(
    OutputChannel &output_channel, OutputConverter<ResultType> converter, core::Step step_from, core::Step step_to)
{
    output_channel.update();
    return converter(output_channel.read_some_from_buffer(step_from, step_to));
}
 
}  // namespace knp::framework::io::output