IPluginComponentInfo.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_IPLUGIN_COMPONENT_INFO_HPP
#define OPENSWMM_IPLUGIN_COMPONENT_INFO_HPP
 
#include <string>
#include <vector>
#include "PluginState.hpp"
 
namespace openswmm {
 
/* Forward declarations */
class IOutputPlugin;
class IReportPlugin;
 
class IPluginComponentInfo {
public:
    virtual ~IPluginComponentInfo() = default;
 
    // -----------------------------------------------------------------------
    // Identity & metadata
    // -----------------------------------------------------------------------
 
    virtual std::string id() const = 0;
 
    virtual std::string caption() const = 0;
 
    virtual std::string description() const = 0;
 
    virtual std::string version() const = 0;
 
    virtual std::string vendor() const = 0;
 
    virtual std::string url() const = 0;
 
    virtual std::vector<std::string> tags() const { return {}; }
 
    // -----------------------------------------------------------------------
    // Licensing
    // -----------------------------------------------------------------------
 
    virtual std::string license_type() const = 0;
 
    virtual std::string license_text() const = 0;
 
    // -----------------------------------------------------------------------
    // Capability queries
    // -----------------------------------------------------------------------
 
    virtual bool provides_output() const = 0;
 
    virtual bool provides_report() const = 0;
 
    // -----------------------------------------------------------------------
    // Factory methods
    // -----------------------------------------------------------------------
 
    virtual IOutputPlugin* create_output_plugin() const { return nullptr; }
 
    virtual IReportPlugin* create_report_plugin() const { return nullptr; }
};
 
// ---------------------------------------------------------------------------
// C factory function signature that plugin .so/.dylib/.dll must export
// ---------------------------------------------------------------------------
 
using PluginInfoFactory = IPluginComponentInfo*(*)();
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_IPLUGIN_COMPONENT_INFO_HPP */