dashboard.py
Go to the documentation of this file.
00001 # Software License Agreement (BSD License)
00002 #
00003 # Copyright (c) 2012, Willow Garage, Inc.
00004 # All rights reserved.
00005 #
00006 # Redistribution and use in source and binary forms, with or without
00007 # modification, are permitted provided that the following conditions
00008 # are met:
00009 #
00010 #  * Redistributions of source code must retain the above copyright
00011 #    notice, this list of conditions and the following disclaimer.
00012 #  * Redistributions in binary form must reproduce the above
00013 #    copyright notice, this list of conditions and the following
00014 #    disclaimer in the documentation and/or other materials provided
00015 #    with the distribution.
00016 #  * Neither the name of Willow Garage, Inc. nor the names of its
00017 #    contributors may be used to endorse or promote products derived
00018 #    from this software without specific prior written permission.
00019 #
00020 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00024 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00027 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00028 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00029 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00030 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00031 # POSSIBILITY OF SUCH DAMAGE.
00032 
00033 import roslib;roslib.load_manifest('rqt_robot_dashboard')
00034 import rospy
00035 
00036 from python_qt_binding.QtCore import QSize
00037 from python_qt_binding.QtGui import QToolBar
00038 from qt_gui.plugin import Plugin
00039 
00040 
00041 class Dashboard(Plugin):
00042     """
00043     Base class from which dashboards should inherit.
00044 
00045     :param context: the plugin context
00046     :type context: qt_gui.plugin.Plugin
00047     """
00048     def __init__(self, context):
00049         super(Dashboard, self).__init__(context)
00050         self.context = context
00051         self.setup(context)
00052 
00053         if not hasattr(self, 'name'):
00054             self.name = 'Dashboard'
00055         if not hasattr(self, 'max_icon_size'):
00056             self.max_icon_size = QSize(50, 30)
00057         self._main_widget = QToolBar()
00058         self._main_widget.setIconSize(self.max_icon_size)
00059         self._main_widget.setObjectName(self.name)
00060         self._main_widget.setWindowTitle(self.name)
00061         if context.serial_number() > 1:
00062             self._main_widget.setWindowTitle(self._main_widget.windowTitle() + (' (%d)' % context.serial_number()))
00063         widgets = self.get_widgets()
00064 
00065         self._widgets = []
00066         for v in widgets:
00067             for i in v:
00068                 try:
00069                     self._main_widget.addWidget(i)
00070                     self._widgets.append(i)
00071                 except:
00072                     raise Exception("All widgets must be a subclass of QWidget!")
00073 
00074             self._main_widget.addSeparator()
00075 
00076         # Display the dashboard
00077         context.add_toolbar(self._main_widget)
00078 
00079     def setup(self, context):
00080         """
00081         Called during ``__init__`` Subclasses should do initialization here.
00082 
00083         NOTE when overriding this method you should provide a ``self.name`` to
00084         avoid naming conflicts.
00085 
00086         :param context: The plugin context
00087         :type context: qt_gui.plugin.Plugin
00088         """
00089         pass
00090 
00091     def shutdown_plugin(self):
00092         """
00093         Called when the toolbar is closed by Qt.
00094         """
00095         for widget in self._widgets:
00096             if hasattr(widget, 'shutdown_widget'):
00097                 widget.shutdown_widget()
00098             if hasattr(widget, 'close'):
00099                 widget.close()
00100 
00101         self.shutdown_dashboard()
00102 
00103     def shutdown_dashboard(self):
00104         """
00105         Called after shutdown plugin, subclasses should do cleanup here, not in shutdown_plugin
00106         """
00107         pass
00108 
00109     def get_widgets(self):
00110         """
00111         Most of the dashboard customization should be done here.
00112         If this function is not overriden the dashboard will display nothing.
00113 
00114         :returns: List of lists containing dashboard widgets.
00115         """
00116         return []


rqt_robot_dashboard
Author(s): Ze'ev Klapow
autogenerated on Fri Jan 3 2014 11:56:25