widgets.py
Go to the documentation of this file.
1 # Software License Agreement (BSD License)
2 #
3 # Copyright (c) 2012, Willow Garage, Inc.
4 # All rights reserved.
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # * Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # * Redistributions in binary form must reproduce the above
13 # copyright notice, this list of conditions and the following
14 # disclaimer in the documentation and/or other materials provided
15 # with the distribution.
16 # * Neither the name of Willow Garage, Inc. nor the names of its
17 # contributors may be used to endorse or promote products derived
18 # from this software without specific prior written permission.
19 #
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 # POSSIBILITY OF SUCH DAMAGE.
32 
33 """
34 .. module:: widgets
35  :synopsis: Widgets for the rqt_robot_dashboard.
36 
37 .. moduleauthor:: Ze'ev Klapow, Aaron Blasdel <ablasdel@gmail.com>
38 
39 This module provides a set of standard widgets for using with the Dashboard class.
40 
41 To use them you must provide instances of them to your dashboard in its :func:`get_widgets` method. For example::
42 
43  from rqt_robot_dashboard.dashboard import Dashboard
44  from rqt_robot_dashboard.widgets import MonitorDashWidget, ConsoleDashWidget, BatteryDashWidget
45 
46  class MyDashboard(Dashboard):
47  def get_widgets(self):
48  self.monitor = MonitorDashWidget(self.context)
49  self.console = ConsoleDashWidget(self.context)
50  self.battery = BatteryDashWidget(self.context)
51 
52  return [[self.monitor, self.console],[self.battery]]
53 
54 Would create a simple dashboard with the ability to open a rqt_robot_monitor and a ROS console and monitor the battery.
55 """
56 
57 from .icon_tool_button import IconToolButton
58 from .battery_dash_widget import BatteryDashWidget
59 from .console_dash_widget import ConsoleDashWidget
60 from .menu_dash_widget import MenuDashWidget
61 from .monitor_dash_widget import MonitorDashWidget
62 from .nav_view_dash_widget import NavViewDashWidget


rqt_robot_dashboard
Author(s): Ze'ev Klapow
autogenerated on Wed Mar 2 2022 00:58:48