ark::gui::PluginSet

Defined in header “ark/gui/plugin_set.hh”.


A plugin set is a grouping of plugins, allowing you to easily poll and dispatch messages over all of the plugins at once.

This also handles some common initialization code for you.

Methods

  • PluginSet(PluginSetConfiguration config)
    Initializes a plugin set with the given configuration.

  • ~PluginSet()
    Destructor, stops all threads.

  • PluginInterfacePtr register_plugin(const PluginPtr & plugin)
    Registers a new plugin with the plugin set. A pointer to the created interface pointer is returned, allowing you to retrieve the widgets that need to be constructed and lay them out.

  • void initialize()
    Initializes all of the plugins, giving them a chance to register subscribers and fill in their UI.

  • void poll()
    Polls all of the communication bridges, potentially reading messages and publishing them onto their subscribers.

  • void save_settings(QSettings & settings)
    Saves settings for all of the plugins contained within this pluginset.

  • void restore_settings(QSettings & settings)
    Restores settings for all of the plugins contained within this pluginset.

  • std::string current_pipeline_instance_id()
    Returns the server instance identifier that we are connected to. This changes if the host pipeline restarts.