ark::gui::Plugin

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

This is an abstract class that allows you to define custom plugins. These “plug into” a Qt GUI and allow you to setup tabs and other GUI elements, along with support for registering comms methods for communicating with the rest of the stack.

Methods

  • Plugin(std::string name, std::string comms_namespace)
    Constructor. Initializes the plugin with the given name and comms namespace. The namespace follows the same rules as the namespace in pipeline stages, applying to both publishers and subscribers.

  • ~Plugin()
    Virtual destructor, for cleanup.

  • void initialize(PluginInterface & interface)
    Called during initialization. This gives you a chance to register you widget elements and communication methods.

  • void save_settings(QSettings & settings)
    Invoked from the parent GUI application to give this plugin a chance to save its settings.

  • void restore_settings(QSettings & settings)
    Called from the parent GUI application to give this plugin a chance to restore its settings.

  • const std::string & name()
    Returns the name of the plugin.

  • const std::string & comms_namespace()
    Returns the comms namespace of the plugin.