rqt_robot_monitor.timeline.Timeline Class Reference

List of all members.

Public Member Functions
def	__init__
def	__iter__
def	__len__
def	callback
def	data_age
def	get_position
def	has_messages
def	is_stale
def	paused
def	queue
def	set_paused
def	set_position
def	shutdown
Static Public Attributes
tuple	message_updated = Signal(DiagnosticArray)
tuple	pause_changed = Signal(bool)
tuple	queue_updated = Signal(deque)
Private Attributes
	_count
	_current_index
	_have_messages
	_last_message_time
	_paused_queue
	_queue
	_queue_copy
	_subscriber

---

Detailed Description

A class which represents the status history of diagnostics
It can be queried for a past history of diagnostics, and paused

Definition at line 43 of file timeline.py.

---

Constructor & Destructor Documentation

def rqt_robot_monitor.timeline.Timeline.__init__	(		self,
			topic,
			topic_type,
			count = 30
	)

Definition at line 52 of file timeline.py.

---

Member Function Documentation

def rqt_robot_monitor.timeline.Timeline.__iter__

(

self

)

Definition at line 167 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.__len__

(

self

)

Definition at line 164 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.callback	(		self,
			msg
	)

ROS Callback for new diagnostic messages

Puts new msg into the queue, and emits a signal to let listeners know
that the timeline has been updated

If the timeline is paused, new messages are placed into a separate
queue and swapped back in when the timeline is unpaused

:type msg: Either DiagnosticArray or DiagnosticsStatus. Can be
   determined by __init__'s arg "msg_callback".

Definition at line 103 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.data_age

(

self

)

Get the age (in seconds) of the most recent diagnostic message 

Definition at line 138 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.get_position

(

self

)

Definition at line 158 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.has_messages

(

self

)

True if this timeline has received any messages.
False if no messages have been received yet

Definition at line 131 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.is_stale

(

self

)

True is this timeline is stale. 

Definition at line 145 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.paused

(

self

)

True if this timeline is paused 

Definition at line 99 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.queue

(

self

)

Definition at line 127 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.set_paused	(		self,
			pause
	)

Slot, to be called to change the pause status of the timeline

This is generally intended to be connected to the status signal
from a button or checkbox

Definition at line 78 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.set_position	(		self,
			index
	)

Definition at line 149 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.shutdown

(

self

)

Turn off this Timeline
Internally, this just shuts down the subscriber

Definition at line 70 of file timeline.py.

---

Member Data Documentation

rqt_robot_monitor::timeline.Timeline::_count [private]

Definition at line 52 of file timeline.py.

rqt_robot_monitor::timeline.Timeline::_current_index [private]

Definition at line 52 of file timeline.py.

rqt_robot_monitor::timeline.Timeline::_have_messages [private]

Definition at line 52 of file timeline.py.

rqt_robot_monitor::timeline.Timeline::_last_message_time [private]

Definition at line 52 of file timeline.py.

rqt_robot_monitor::timeline.Timeline::_paused_queue [private]

Definition at line 52 of file timeline.py.

rqt_robot_monitor::timeline.Timeline::_queue [private]

Definition at line 52 of file timeline.py.

rqt_robot_monitor::timeline.Timeline::_queue_copy [private]

Definition at line 52 of file timeline.py.

rqt_robot_monitor::timeline.Timeline::_subscriber [private]

Definition at line 52 of file timeline.py.

tuple rqt_robot_monitor::timeline.Timeline::message_updated = Signal(DiagnosticArray) [static]

Definition at line 48 of file timeline.py.

tuple rqt_robot_monitor::timeline.Timeline::pause_changed = Signal(bool) [static]

Definition at line 50 of file timeline.py.

tuple rqt_robot_monitor::timeline.Timeline::queue_updated = Signal(deque) [static]

Definition at line 49 of file timeline.py.

---

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

• timeline.py