widgets.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 """
00034 .. module:: widgets
00035     :synopsis: Widgets for the rqt_robot_dashboard.
00036 
00037 .. moduleauthor:: Ze'ev Klapow, Aaron Blasdel <ablasdel@gmail.com>
00038 
00039 This module provides a set of standard widgets for using with the Dashboard class.
00040 
00041 To use them you must provide instances of them to your dashboard in its :func:`get_widgets` method. For example::
00042 
00043     from rqt_robot_dashboard.dashboard import Dashboard
00044     from rqt_robot_dashboard.widgets import MonitorDashWidget, ConsoleDashWidget, BatteryDashWidget
00045 
00046     class MyDashboard(Dashboard):
00047         def get_widgets(self):
00048             self.monitor = MonitorDashWidget(self.context)
00049             self.console = ConsoleDashWidget(self.context)
00050             self.battery = BatteryDashWidget(self.context)
00051 
00052             return [[self.monitor, self.console],[self.battery]]
00053 
00054 Would create a simple dashboard with the ability to open a rqt_robot_monitor and a ROS console and monitor the battery.
00055 """
00056 
00057 from .icon_tool_button import IconToolButton
00058 from .battery_dash_widget import BatteryDashWidget
00059 from .console_dash_widget import ConsoleDashWidget
00060 from .menu_dash_widget import MenuDashWidget
00061 from .monitor_dash_widget import MonitorDashWidget
00062 from .nav_view_dash_widget import NavViewDashWidget


rqt_robot_dashboard
Author(s): Ze'ev Klapow
autogenerated on Wed May 3 2017 02:40:43