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

Public Member Functions

def __init__ (self, context)
 
def add_widgets (self)
 
def get_widgets (self)
 
def setup (self, context)
 
def shutdown_dashboard (self)
 
def shutdown_plugin (self)
 
- Public Member Functions inherited from qt_gui::plugin::Plugin
def __init__ (self, context)
 
def restore_settings (self, plugin_settings, instance_settings)
 
def save_settings (self, plugin_settings, instance_settings)
 
def shutdown_plugin (self)
 

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

◆ __init__()

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

Definition at line 45 of file dashboard.py.

Member Function Documentation

◆ add_widgets()

def rqt_robot_dashboard.dashboard.Dashboard.add_widgets (   self)
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.

◆ get_widgets()

def rqt_robot_dashboard.dashboard.Dashboard.get_widgets (   self)
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.

◆ setup()

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.

◆ shutdown_dashboard()

def rqt_robot_dashboard.dashboard.Dashboard.shutdown_dashboard (   self)
Called after shutdown plugin, subclasses should do cleanup here, not in shutdown_plugin

Definition at line 91 of file dashboard.py.

◆ shutdown_plugin()

def rqt_robot_dashboard.dashboard.Dashboard.shutdown_plugin (   self)
Called when the toolbar is closed by Qt.

Definition at line 79 of file dashboard.py.

Member Data Documentation

◆ _main_widget

rqt_robot_dashboard.dashboard.Dashboard._main_widget
private

Definition at line 54 of file dashboard.py.

◆ _widgets

rqt_robot_dashboard.dashboard.Dashboard._widgets
private

Definition at line 114 of file dashboard.py.

◆ context

rqt_robot_dashboard.dashboard.Dashboard.context

Definition at line 47 of file dashboard.py.

◆ max_icon_size

rqt_robot_dashboard.dashboard.Dashboard.max_icon_size

Definition at line 53 of file dashboard.py.

◆ name

rqt_robot_dashboard.dashboard.Dashboard.name

Definition at line 51 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 Wed Mar 2 2022 00:58:48