IOutputPlugin.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_IOUTPUT_PLUGIN_HPP
#define OPENSWMM_IOUTPUT_PLUGIN_HPP
 
#include <string>
#include <vector>
#include "PluginState.hpp"
#include "SimulationSnapshot.hpp"
 
/* Forward declaration — avoid pulling in the full SimulationContext */
namespace openswmm { struct SimulationContext; }
 
namespace openswmm {
 
class IOutputPlugin {
public:
    virtual ~IOutputPlugin() = default;
 
    // -----------------------------------------------------------------------
    // State query
    // -----------------------------------------------------------------------
 
    virtual PluginState state() const noexcept = 0;
 
    // -----------------------------------------------------------------------
    // Lifecycle methods (main thread)
    // -----------------------------------------------------------------------
 
    virtual int initialize(
        const std::vector<std::string>& init_args,
        const class IPluginComponentInfo* info
    ) = 0;
 
    virtual int validate(const SimulationContext& ctx) = 0;
 
    virtual int prepare(const SimulationContext& ctx) = 0;
 
    virtual int update(const SimulationSnapshot& snapshot) = 0;
 
    virtual int finalize(const SimulationContext& ctx) = 0;
 
    // -----------------------------------------------------------------------
    // Optional: error message
    // -----------------------------------------------------------------------
 
    virtual const char* last_error_message() const noexcept { return ""; }
};
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_IOUTPUT_PLUGIN_HPP */