plot_reporter.h

Go to the documentation of this file.

/*
 * Copyright 2025 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include <memory>
#include <string>
#include <vector>
 
#include "stat_bench/measurer/measurement.h"
#include "stat_bench/measurer/measurer_name.h"
#include "stat_bench/plots/i_plot.h"
#include "stat_bench/reporter/i_reporter.h"
#include "stat_bench/util/utf8_string.h"
 
namespace stat_bench {
namespace reporter {

class PlotReporter final : public IReporter {
public:
    explicit PlotReporter(std::string prefix);

    void experiment_starts(const clock::SystemTimePoint& time_stamp) override;

    void experiment_finished(const clock::SystemTimePoint& time_stamp) override;

    void measurer_starts(const measurer::MeasurerName& name) override;

    void measurer_finished(const measurer::MeasurerName& name) override;

    void group_starts(const BenchmarkGroupName& name,
        const bench_impl::BenchmarkGroupConfig& config) override;

    void group_finished(const BenchmarkGroupName& name) override;

    void case_starts(const BenchmarkFullName& case_info) override;

    void case_finished(const BenchmarkFullName& case_info) override;

    void measurement_succeeded(
        const measurer::Measurement& measurement) override;

    void measurement_failed(const BenchmarkFullName& case_info,
        const BenchmarkCondition& cond,
        const std::exception_ptr& error) override;
 
private:
    std::string prefix_;

    measurer::MeasurerName measurer_name_;

    util::Utf8String measurer_name_for_file_paths_;

    std::vector<measurer::Measurement> measurements_{};

    std::vector<std::shared_ptr<plots::IPlot>> builtin_plots_{};

    std::vector<std::shared_ptr<plots::IPlot>> group_plots_{};
};
 
}  // namespace reporter
}  // namespace stat_bench