DefaultReportPlugin.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// 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.

 
#ifndef OPENSWMM_ENGINE_DEFAULT_REPORT_PLUGIN_HPP
#define OPENSWMM_ENGINE_DEFAULT_REPORT_PLUGIN_HPP
 
#include "../../../include/openswmm/plugin_sdk/IReportPlugin.hpp"
 
#include <ctime>
#include <string>
 
namespace openswmm {

class DefaultReportPlugin final : public IReportPlugin {
public:
    explicit DefaultReportPlugin(std::string rpt_path);
    ~DefaultReportPlugin() override;

    PluginState state() const noexcept override { return state_; }

    int initialize(const std::vector<std::string>& init_args,
                   const IPluginComponentInfo* info) override;

    int validate(const SimulationContext& ctx) override;
    int prepare(const SimulationContext& ctx) override;
    int update(const SimulationSnapshot& snapshot) override;
    int finalize(const SimulationContext& ctx) override;

    int write_summary(const SimulationContext& ctx) override;
    // Managed sessions create a new report and never truncate a late collision.
    void requireFreshOutput() noexcept { checkpoint_fresh_ = true; }

    const char* last_error_message() const noexcept override { return last_error_.c_str(); }
 
private:
    std::string rpt_path_;
    PluginState state_ = PluginState::UNLOADED;
    std::string last_error_;
    bool checkpoint_fresh_ = false;
 
    // Progressive write state
    std::FILE* file_ = nullptr;        
    std::size_t warnings_written_ = 0; 
    std::size_t errors_written_ = 0;   

    void write_preamble(std::FILE* f, const SimulationContext& ctx);

    void write_results(std::FILE* f, const SimulationContext& ctx);

    void write_timing(std::FILE* f, const SimulationContext& ctx);
};
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_ENGINE_DEFAULT_REPORT_PLUGIN_HPP */