i_reporter.h

Go to the documentation of this file.

/*
 * Copyright 2021 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 <exception>
 
#include "stat_bench/bench_impl/benchmark_group_config.h"
#include "stat_bench/benchmark_condition.h"
#include "stat_bench/benchmark_full_name.h"
#include "stat_bench/benchmark_group_name.h"
#include "stat_bench/clock/system_time_point.h"
#include "stat_bench/measurer/measurement.h"
#include "stat_bench/measurer/measurer_name.h"
 
namespace stat_bench {
namespace reporter {

class IReporter {
public:
    virtual void experiment_starts(
        const clock::SystemTimePoint& time_stamp) = 0;

    virtual void experiment_finished(
        const clock::SystemTimePoint& time_stamp) = 0;

    virtual void measurer_starts(const measurer::MeasurerName& name) = 0;

    virtual void measurer_finished(const measurer::MeasurerName& name) = 0;

    virtual void group_starts(const BenchmarkGroupName& name,
        const bench_impl::BenchmarkGroupConfig& config) = 0;

    virtual void group_finished(const BenchmarkGroupName& name) = 0;

    virtual void case_starts(const BenchmarkFullName& case_info) = 0;

    virtual void case_finished(const BenchmarkFullName& case_info) = 0;

    virtual void measurement_succeeded(
        const measurer::Measurement& measurement) = 0;

    virtual void measurement_failed(const BenchmarkFullName& case_info,
        const BenchmarkCondition& cond, const std::exception_ptr& error) = 0;
 
    IReporter(const IReporter&) = delete;
    IReporter(IReporter&&) = delete;
    auto operator=(const IReporter&) -> IReporter& = delete;
    auto operator=(IReporter&&) -> IReporter& = delete;

    virtual ~IReporter() = default;
 
protected:
    IReporter() = default;
};
 
}  // namespace reporter
}  // namespace stat_bench