stats_interface.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "stats_snapshot.h"
#include <string>
#include <string_view>
#include <unordered_map>
#include <variant>
 
namespace kcenon::common::interfaces {
 
using stats_value = std::variant<
    std::int64_t,    
    double,          
    std::string,     
    bool             
>;
 
class IStats {
public:
    virtual ~IStats() = default;
 
    [[nodiscard]] virtual auto get_stats() const -> std::unordered_map<std::string, stats_value> = 0;
 
    [[nodiscard]] virtual auto to_json() const -> std::string = 0;
 
    [[nodiscard]] virtual auto name() const -> std::string_view = 0;
 
    [[nodiscard]] virtual auto get_snapshot() const -> stats_snapshot
    {
        return stats_snapshot{
            .component_name = std::string(name()),
            .timestamp = std::chrono::system_clock::now(),
            .values = get_stats()
        };
    }
};
 
} // namespace kcenon::common::interfaces