Public Member Functions | Private Member Functions | Private Attributes | List of all members
airbus_cobot_gui.plugin.plugin_provider.PluginProvider Class Reference

Class for load Python plugin package. More...

Public Member Functions

def __init__
 The constructor. More...
 
def get_plugin_registered
 Find plugin package name and xml name registered in plugins_register.xml. More...
 
def load
 Load Python package. More...
 

Private Member Functions

def _parse_plugin_xml
 Read plugin xml file. More...
 

Private Attributes

 _label
 
 _plugin_register
 

Detailed Description

Class for load Python plugin package.

PluginProvider interacts with ros plugin package. The first is its
import plugin, and the second is the set plugin configuration which
it reads.

Definition at line 38 of file plugin_provider.py.

Constructor & Destructor Documentation

def airbus_cobot_gui.plugin.plugin_provider.PluginProvider.__init__ (   self,
  xml_register_dir 
)

The constructor.

Definition at line 46 of file plugin_provider.py.

Member Function Documentation

def airbus_cobot_gui.plugin.plugin_provider.PluginProvider._parse_plugin_xml (   self,
  package_name,
  plugin_xml 
)
private

Read plugin xml file.

Parameters
package_namepython pakage name. package_name: string.
plugin_xmlplugin xml name. plugin_xml: string.
Returns
: plugin_desc: package descrition, plugin configuration. plugin_desc: tuple (dictonary, dictonary).

Definition at line 141 of file plugin_provider.py.

def airbus_cobot_gui.plugin.plugin_provider.PluginProvider.get_plugin_registered (   self,
  plugin_label 
)

Find plugin package name and xml name registered in plugins_register.xml.

Parameters
plugin_labelplugin label. package_name: string.
Returns
plugin_desc: package name and xml file name. plugin_desc: tuple (string, string).

Definition at line 62 of file plugin_provider.py.

def airbus_cobot_gui.plugin.plugin_provider.PluginProvider.load (   self,
  node,
  plugin_label 
)

Load Python package.

Parameters
package_namepackage name. package_name: string.
plugin_xmlxml file name. plugin_xml: string.
Returns
plugin_instance: plugin instance. plugin_instance: CobotUiPlugin.

Definition at line 83 of file plugin_provider.py.

Member Data Documentation

airbus_cobot_gui.plugin.plugin_provider.PluginProvider._label
private

Definition at line 49 of file plugin_provider.py.

airbus_cobot_gui.plugin.plugin_provider.PluginProvider._plugin_register
private

Definition at line 58 of file plugin_provider.py.


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


airbus_cobot_gui
Author(s):
autogenerated on Thu Dec 17 2015 11:42:05