mc_control::GlobalPlugin Struct Reference

#include <mc_control/GlobalPlugin.h>

Classes
struct	GlobalPluginConfiguration

Public Member Functions
virtual	~GlobalPlugin ()=default
virtual GlobalPluginConfiguration	configuration ()
virtual void	init (mc_control::MCGlobalController &controller, const mc_rtc::Configuration &config)=0
virtual void	reset (mc_control::MCGlobalController &controller)=0
virtual void	before (mc_control::MCGlobalController &controller)=0
virtual void	after (mc_control::MCGlobalController &controller)=0

Constructor & Destructor Documentation

~GlobalPlugin()

virtual mc_control::GlobalPlugin::~GlobalPlugin ( )

virtualdefault

Member Function Documentation

after()

virtual void mc_control::GlobalPlugin::after ( mc_control::MCGlobalController &  controller )

pure virtual

Run after mc_control::MCGlobalController::run()

Parameters

controller

MCGlobalController instance that owns this plugin

before()

virtual void mc_control::GlobalPlugin::before ( mc_control::MCGlobalController &  controller )

pure virtual

Run before mc_control::MCGlobalController::run()

Parameters

controller

MCGlobalController instance that owns this plugin

configuration()

virtual GlobalPluginConfiguration mc_control::GlobalPlugin::configuration ( )

inlinevirtual

Returns the plugin running configuration

This impacts which functions are called and when they are called

init()

virtual void mc_control::GlobalPlugin::init ( mc_control::MCGlobalController &  controller, const mc_rtc::Configuration &  config  )

pure virtual

Initialize the plugin

This function is called when the plugin is created by the MCGlobalController instance

The plugin configuration is read from:

• $PLUGIN_DIR/etc/$PLUGIN_NAME.yaml
• $HOME/.config/mc_rtc/plugins/$PLUGIN_NAME.yaml on Linux/macOS
• APPDATA%/mc_rtc/plugins/$PLUGIN_NAME.yaml on Windows

Parameters

controller	MCGlobalController instance that owns this plugin
config	Plugin configuration

reset()

virtual void mc_control::GlobalPlugin::reset ( mc_control::MCGlobalController &  controller )

pure virtual

Reset the plugin

This function is called when the controller is switched

Parameters

controller

MCGlobalController instance that owns this plugin

---

The documentation for this struct was generated from the following file:

• include/mc_control/GlobalPlugin.h