carbon_config.hpp

Go to the documentation of this file.

// Copyright (c) 2024-2025 Voyant Photonics, Inc.
// All rights reserved.
 
#pragma once
 
#include <carbon_client_ffi.hpp>
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
class CarbonConfig
{
public:
    CarbonConfig();
    ~CarbonConfig();
 
    static std::unique_ptr<CarbonConfig> fromJson(const std::string& path);
 
    // Non-copyable, non-movable (owns raw FFI pointer)
    CarbonConfig(const CarbonConfig&)            = delete;
    CarbonConfig& operator=(const CarbonConfig&) = delete;
    CarbonConfig(CarbonConfig&&)                 = delete;
    CarbonConfig& operator=(CarbonConfig&&)      = delete;
 
    // ── Connection ────────────────────────────────────────────────────────────
    CarbonConfig& setBindAddr(const std::string& v);
    CarbonConfig& setGroupAddr(const std::string& v);
    CarbonConfig& setInterfaceAddr(const std::string& v);
 
    // ── Receiver ──────────────────────────────────────────────────────────────
    CarbonConfig& setUseMsgTimestamp(bool v);
    CarbonConfig& setBatchSize(size_t v);
    CarbonConfig& setRecvBufferSize(size_t v);
    CarbonConfig& setReceiverChannelCapacity(size_t v);
 
    // ── DSP ───────────────────────────────────────────────────────────────────
    CarbonConfig& setPfa(float v);
    CarbonConfig& setVelCorrFactor(float v);
    CarbonConfig& setBandwidthHz(float v);
    CarbonConfig& setElevationFovDeg(float v);
 
    // ── Frame Assembler ───────────────────────────────────────────────────────
    CarbonConfig& setKeepInvalidPoints(bool v);
 
    // ── Geometric Bounds ──────────────────────────────────────────────────────
    CarbonConfig& setRangeMin(float v);
    CarbonConfig& setRangeMax(float v);
    CarbonConfig& setDopplerMin(float v);
    CarbonConfig& setDopplerMax(float v);
    CarbonConfig& setAzimuthDegMin(float v);
    CarbonConfig& setAzimuthDegMax(float v);
    CarbonConfig& setElevationDegMin(float v);
    CarbonConfig& setElevationDegMax(float v);
 
    // ── Spatial Outlier Filter ────────────────────────────────────────────────
    CarbonConfig& setSpatialRangeThreshold(float v);
    CarbonConfig& setSpatialDopplerThreshold(float v);
    CarbonConfig& setSpatialMinNeighbors(uint8_t v);
 
    // ── Elevation Interpolator ────────────────────────────────────────────────
    CarbonConfig& setInterpRangeThreshold(float v);
    CarbonConfig& setInterpDopplerThreshold(float v);
    CarbonConfig& setMissingElevations(const std::vector<uint8_t>& elevations);
 
    // ── Peaks Mirroring ───────────────────────────────────────────────────────
    CarbonConfig& setMirrorPeaks(bool v);
    CarbonConfig& setMirrorGroupAddr(const std::string& v);
    CarbonConfig& setMirrorBindAddr(const std::string& v);
 
    // ── Eval ──────────────────────────────────────────────────────────────────
    CarbonConfig& setEvalMode(bool v);
    CarbonConfig& setReportDir(const std::string& v);
 
private:
    friend class CarbonClient;
    CarbonConfigC* cfg_;                       // opaque pointer — type defined in carbon_client_ffi.hpp
    explicit CarbonConfig(CarbonConfigC* raw); // takes ownership
};