rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget Class Reference

Inheritance diagram for rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget:

List of all members.

Public Member Functions
def	__init__
def	set_charging
def	update_perc
def	update_time
Private Member Functions
def	_update_state
Private Attributes
	_charge_icons
	_charging

---

Detailed Description

A Widget which displays incremental battery state, including a status tip.
To use this widget simply call `update_perc` and `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 36 of file battery_dash_widget.py.

---

Constructor & Destructor Documentation

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

Definition at line 44 of file battery_dash_widget.py.

---

Member Function Documentation

def rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget._update_state	(		self,
			state
	)		[private]

Definition at line 73 of file battery_dash_widget.py.

def rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget.set_charging	(		self,
			value
	)

Definition at line 61 of file battery_dash_widget.py.

def rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget.update_perc	(		self,
			val
	)

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 64 of file battery_dash_widget.py.

def rqt_robot_dashboard.battery_dash_widget.BatteryDashWidget.update_time	(		self,
			value
	)

Definition at line 79 of file battery_dash_widget.py.

---

Member Data Documentation

rqt_robot_dashboard::battery_dash_widget.BatteryDashWidget::_charge_icons [private]

Definition at line 44 of file battery_dash_widget.py.

rqt_robot_dashboard::battery_dash_widget.BatteryDashWidget::_charging [private]

Definition at line 44 of file battery_dash_widget.py.

---

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

• battery_dash_widget.py