correlatorIf.hpp

Go to the documentation of this file.

#ifndef RTCTK_TELSUB_CORRELATORIF_HPP
#define RTCTK_TELSUB_CORRELATORIF_HPP
#include <rtctk/telSub/ddsWaitSet.hpp>
#include <rtctk/config.hpp>
 
#include <chrono>
#include <optional>
 
#include <rtctk/telSub/agnosticDataSamples.hpp>
#include <rtctk/telSub/dataSampleView.hpp>
 
namespace rtctk::telSub {
 
struct CorrelationFailedError {
    std::string_view topic;
    uint32_t expected_sample_id;
    uint32_t actual_sample_id;
    bool operator==(const CorrelationFailedError& b) const {
        return b.topic == topic and b.expected_sample_id == expected_sample_id and
               b.actual_sample_id == actual_sample_id;
    }
};
 
using CorrelationError = std::variant<CorrelationFailedError, DdsWaitSetError>;

struct CorrelatorParams {
    uint32_t m_expected_sample_id_increment = 1;
};

class CorrelatorIf {
public:
    virtual ~CorrelatorIf() = default;

    virtual std::optional<std::uint32_t> GetLastSampleId() const noexcept = 0;

    virtual std::optional<CorrelationError>
    Poll(std::chrono::milliseconds timeout, const DataSamplesView*& view) noexcept = 0;

    virtual void Reset() noexcept = 0;
 
    virtual void CheckDdsConnections() = 0;
};
 
}  // namespace rtctk::telSub
 
#endif  // RTCTK_TELSUB_CORRELATORIF_HPP