Public Member Functions | Private Member Functions | Private Attributes | List of all members
rqt_gui.ros_plugin_provider.RosPluginProvider Class Reference
Inheritance diagram for rqt_gui.ros_plugin_provider.RosPluginProvider:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, export_tag, base_class_type)
 
def discover (self, discovery_data)
 
def load (self, plugin_id, plugin_context)
 
def unload (self, plugin_instance)
 
- Public Member Functions inherited from qt_gui::plugin_provider::PluginProvider
def __init__ (self)
 
def discover (self, discovery_data)
 
def load (self, plugin_id, plugin_context)
 
def shutdown (self)
 
def unload (self, plugin_instance)
 

Private Member Functions

def _find_plugins (self, export_tag, discovery_data)
 
def _parse_action_group (self, group_el)
 
def _parse_plugin (self, class_el)
 
def _parse_plugin_xml (self, package_name, plugin_xml)
 

Private Attributes

 _base_class_type
 
 _export_tag
 
 _plugin_descriptors
 

Detailed Description

Base class for providing plugins based on the ROS package system.

Definition at line 46 of file ros_plugin_provider.py.

Constructor & Destructor Documentation

◆ __init__()

def rqt_gui.ros_plugin_provider.RosPluginProvider.__init__ (   self,
  export_tag,
  base_class_type 
)

Reimplemented in rqt_gui.rospkg_plugin_provider.RospkgPluginProvider.

Definition at line 49 of file ros_plugin_provider.py.

Member Function Documentation

◆ _find_plugins()

def rqt_gui.ros_plugin_provider.RosPluginProvider._find_plugins (   self,
  export_tag,
  discovery_data 
)
private

◆ _parse_action_group()

def rqt_gui.ros_plugin_provider.RosPluginProvider._parse_action_group (   self,
  group_el 
)
private

Definition at line 201 of file ros_plugin_provider.py.

◆ _parse_plugin()

def rqt_gui.ros_plugin_provider.RosPluginProvider._parse_plugin (   self,
  class_el 
)
private

Definition at line 187 of file ros_plugin_provider.py.

◆ _parse_plugin_xml()

def rqt_gui.ros_plugin_provider.RosPluginProvider._parse_plugin_xml (   self,
  package_name,
  plugin_xml 
)
private

Definition at line 114 of file ros_plugin_provider.py.

◆ discover()

def rqt_gui.ros_plugin_provider.RosPluginProvider.discover (   self,
  discovery_data 
)
Discover the plugins.

The information of the `PluginDescriptor`s are extracted from the plugin manifests.

Definition at line 57 of file ros_plugin_provider.py.

◆ load()

def rqt_gui.ros_plugin_provider.RosPluginProvider.load (   self,
  plugin_id,
  plugin_context 
)

Definition at line 73 of file ros_plugin_provider.py.

◆ unload()

def rqt_gui.ros_plugin_provider.RosPluginProvider.unload (   self,
  plugin_instance 
)

Definition at line 108 of file ros_plugin_provider.py.

Member Data Documentation

◆ _base_class_type

rqt_gui.ros_plugin_provider.RosPluginProvider._base_class_type
private

Definition at line 54 of file ros_plugin_provider.py.

◆ _export_tag

rqt_gui.ros_plugin_provider.RosPluginProvider._export_tag
private

Definition at line 53 of file ros_plugin_provider.py.

◆ _plugin_descriptors

rqt_gui.ros_plugin_provider.RosPluginProvider._plugin_descriptors
private

Definition at line 55 of file ros_plugin_provider.py.


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


rqt_gui
Author(s): Dirk Thomas
autogenerated on Sun Mar 21 2021 02:32:32