Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes
rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget Class Reference

List of all members.

Public Member Functions

def __init__
def set_charging
def state
def update_perc
def update_state
def update_time

Static Public Attributes

tuple state_changed = Signal(int)

Private Member Functions

def _update_state

Private Attributes


Detailed Description

A Widget which displays incremental battery state, including a status tip.
To use this widget simply call :func:`update_perc` and :func:`update_time`
to change the displayed charge percentage and time remaining, respectively.

:param name: The name of this widget
:type name: str

Definition at line 40 of file

Constructor & Destructor Documentation

def rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget.__init__ (   self,
  name = 'Battery',
  icons = None,
  charge_icons = None,
  icon_paths = None,
  suppress_overlays = False 

Definition at line 51 of file

Member Function Documentation

Definition at line 76 of file

Definition at line 89 of file

Read-only accessor for the widgets current state.

Definition at line 83 of file

Update the displayed battery percentage.
The default implementation of this method displays in 20% increments

:param val: The new value to be displayed.
:type val: int

Definition at line 92 of file

Set the state of this button.
This will also update the icon for the button based on the ``self._icons`` list

:raises IndexError: If state is not a proper index to ``self._icons``

:param state: The state to set.
:type state: int

Definition at line 102 of file

Definition at line 118 of file

Member Data Documentation

Definition at line 51 of file

Definition at line 51 of file

Definition at line 51 of file

Definition at line 51 of file

Definition at line 51 of file

Definition at line 51 of file

Definition at line 49 of file

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

Author(s): Ze'ev Klapow
autogenerated on Fri Aug 28 2015 12:50:54