replay.h

#pragma once
#include <atomic>
#include <cstdint>
#include <optional>
#include <string>
 
#include "SenderConfigs.h"
 
#ifdef WIN32
// Export symbols if compile flags "READOUT_SHARED" and "READOUT_EXPORT" are set on Windows.
    #ifdef READOUT_SHARED
        #ifdef READOUT_EXPORT
            #define RL_API __declspec(dllexport)
        #else
            #define RL_API __declspec(dllimport)
        #endif
    #else
        // Disable definition if linking statically.
        #define RL_API
    #endif
#else
// Disable definition for non-Win32 systems.
#define RL_API
#endif
 
enum Replay {NONE = 0, ALL = 1, SEQUENTIAL = 2, RANDOM = 4};
 
class RL_API ParameterPublisher {
public:
  virtual ~ParameterPublisher() = default;
  virtual void publish(size_t point, const std::string & name, const std::string & value, const std::optional<std::string> & unit) = 0;
  virtual void point_ready(size_t /*point*/) {}
  virtual void pulse_ready(size_t /*point*/, uint64_t /*pulse_ns*/) {}
};
 
class RL_API NullParameterPublisher final : public ParameterPublisher {
public:
  void publish(size_t, const std::string &, const std::string &, const std::optional<std::string> &) override {}
};
 
class RL_API StreamParameterPublisher final : public ParameterPublisher {
  std::ostream & out_;
public:
  explicit StreamParameterPublisher(std::ostream & out): out_{out} {}
  void publish(size_t point, const std::string & name, const std::string & value, const std::optional<std::string> & unit) override;
};
 
struct RL_API ReplaySubset {
  size_t first{0};
  size_t number{0};
  size_t every{1};
};
 
// New fields need a matching setter in readout_capi.h and a field in the
// mcstas_readout.ReplayConfig Python dataclass (bump READOUT_CAPI_ABI_VERSION on change).
struct RL_API ReplayConfig {
  std::optional<double> counting_time{std::nullopt};
  uint32_t seed{0};
  bool random_order{false};
  SenderConfigs senders{};
  std::string default_address{"127.0.0.1"};
  int default_port{9000};
  size_t chunk_size{65536};
  std::optional<ReplaySubset> subset{std::nullopt};
  double pulse_rate{14.0};
  bool fold_tof{false};
  size_t pulses_per_point{0};
  const std::atomic<bool> * stop{nullptr};
};
 
RL_API bool replay(const std::string & filename, const ReplayConfig & config, ParameterPublisher & publisher);
RL_API bool replay(const std::string & filename, const ReplayConfig & config);
 
RL_API void replay_all(const std::string & filename, const std::string & address, int port, int control);
 
RL_API void replay_subset(const std::string & filename, const std::string & address, int port, size_t first, size_t number, size_t every, int control);