Public Member Functions | Public Attributes | Private Attributes
rqt_robot_dashboard.dashboard.Dashboard Class Reference
Inheritance diagram for rqt_robot_dashboard.dashboard.Dashboard:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def add_widgets
def get_widgets
def setup
def shutdown_dashboard
def shutdown_plugin

Public Attributes

 context
 max_icon_size
 name

Private Attributes

 _main_widget
 _widgets

Detailed Description

Base class from which dashboards should inherit.

:param context: the plugin context
:type context: qt_gui.plugin.Plugin

Definition at line 38 of file dashboard.py.


Constructor & Destructor Documentation

def rqt_robot_dashboard.dashboard.Dashboard.__init__ (   self,
  context 
)

Definition at line 45 of file dashboard.py.


Member Function Documentation

Add groups of widgets to _main_widget. Supports group labels.

This method can be reimplemented in order to customize appearances.

Definition at line 107 of file dashboard.py.

Most of the dashboard customization should be done here.
If this function is not overriden the dashboard will display nothing.

:returns: List of lists containing dashboard widgets, or list of lists
  containing a string followed by a list of dashboard widgets.

Definition at line 97 of file dashboard.py.

def rqt_robot_dashboard.dashboard.Dashboard.setup (   self,
  context 
)
Called during ``__init__`` Subclasses should do initialization here.

NOTE when overriding this method you should provide a ``self.name`` to
avoid naming conflicts.

:param context: The plugin context
:type context: qt_gui.plugin.Plugin

Definition at line 67 of file dashboard.py.

Called after shutdown plugin, subclasses should do cleanup here, not in shutdown_plugin

Definition at line 91 of file dashboard.py.

Called when the toolbar is closed by Qt.

Definition at line 79 of file dashboard.py.


Member Data Documentation

Definition at line 45 of file dashboard.py.

Definition at line 111 of file dashboard.py.

Definition at line 45 of file dashboard.py.

Definition at line 45 of file dashboard.py.

Definition at line 45 of file dashboard.py.


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


rqt_robot_dashboard
Author(s): Ze'ev Klapow
autogenerated on Sat Jun 8 2019 20:02:45