IStateIOPlugin.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ISTATE_IO_PLUGIN_HPP
#define OPENSWMM_ISTATE_IO_PLUGIN_HPP
 
#include <string>
#include <vector>
#include "PluginState.hpp"
 
namespace openswmm {
 
struct SimulationContext;
class IPluginComponentInfo;
 
class IStateIOPlugin {
public:
    virtual ~IStateIOPlugin() = default;
 
    virtual PluginState state() const noexcept = 0;
 
    virtual int initialize(
        const std::vector<std::string>& init_args,
        const IPluginComponentInfo* info
    ) = 0;
 
    virtual int validate(const SimulationContext& ctx) = 0;
 
    virtual bool can_read(const std::string& path) const { return false; }
 
    virtual int read_state(const std::string& path, SimulationContext& ctx) = 0;
 
    virtual int write_state(const std::string& path, const SimulationContext& ctx) = 0;
 
    virtual std::vector<std::string> warnings() const { return {}; }
 
    virtual int finalize(const SimulationContext& ctx) = 0;
 
    virtual const char* last_error_message() const noexcept { return ""; }
};
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_ISTATE_IO_PLUGIN_HPP */