config.hpp

Go to the documentation of this file.

 
#ifndef RTCTK_REUSABLECOMPONENT_MUDPIPUB_CONFIG_HPP
#define RTCTK_REUSABLECOMPONENT_MUDPIPUB_CONFIG_HPP
 
#include <numapp/numapolicies.hpp>
 
#include <chrono>
#include <optional>
#include <string>
#include <tuple>
#include <vector>
 
namespace rtctk::mudpiPub {

struct PubDynamicCfg {
    // The total sample size in bytes, i.e. the total size of the payloads across all frames.
    uint32_t sample_size = 47000;
 
    // how much to increment the sample id each cycle
    uint32_t sample_id_increment = 1;
 
    // An identifier indicating the payload pattern to generate.
    std::string payload_pattern = "alternating_uint8_ramp";
};

struct PubStaticCfg {
    // The network_adapter_ip which shall be used for sending multicast MUDPI traffic,
    // destination IP for unicast MUDPI packets.
    std::string network_adapter_ip = "127.0.0.1";
 
    // The multicast group where MUDPI packets are sent.
    std::string multicast_group;
 
    // The destination port where packets are sent.
    uint16_t port = 6000;
 
    // The topic ID to encode into the packets.
    int32_t topic_id = 0;
 
    // The MUDPI component id
    uint16_t component_id = 25;
 
    // The MUDPI application tag
    uint16_t application_tag = 0;
 
    // The size of the buffer for a single MUDPI packet in bytes (incl. MUDPI header and checksum).
    uint32_t buffer_size = 8972;  // 9000 (ESO MTU) - 20 (IP header) - 8 (UDP header)
 
    // Flag if MUDPI frame checksum should be calculated
    bool calculate_checksum = true;
 
    // Whether this publisher is enabled
    bool enabled = true;
 
    // thread policies
    std::optional<numapp::NumaPolicies> thread_policies = std::nullopt;
};

struct PubCfg : public PubStaticCfg, PubDynamicCfg {};

struct AppCfg {
    // cppcheck-suppress-begin unusedStructMember
 
    // Delay between samples in microseconds.
    std::chrono::microseconds period_us{1'000'000};
 
    // The maximum number of samples to generate. Negative numbers indicate no maximum.
    int64_t max_samples = -1;
 
    // By how much to increment sample id every cycle
    uint32_t sample_id_increment = 1;
 
    // Pathname of the FITS file to load
    std::string data_file;
 
    // Optional absolute publication start timestamp.
    // Empty string means start immediately.
    std::string publication_start_timestamp;
 
    // config of individual channels
    std::vector<std::tuple<std::string, PubCfg>> pubs;
 
    // cppcheck-suppress-end unusedStructMember
};
 
}  // namespace rtctk::mudpiPub
 
#endif  // RTCTK_REUSABLECOMPONENT_MUDPIPUB_CONFIG_HPP