rqt_robot_monitor.timeline.Timeline Class Reference

Inheritance diagram for rqt_robot_monitor.timeline.Timeline:

Public Member Functions
def	__init__ (self, topic, topic_type, count=30)
def	__iter__ (self)
def	__len__ (self)
def	callback (self, msg)
def	data_age (self)
def	get_all_status_by_name (self, name)
def	get_current_status_by_name (self, name)
def	has_messages (self)
def	is_stale (self)
def	paused (self)
def	position (self)
def	position (self, index)
def	set_paused (self, pause)
def	set_position (self, position)
def	shutdown (self)

Public Attributes
	position

Static Public Attributes
	message_updated = Signal(dict)
	pause_changed = Signal(bool)
	position_changed = Signal(int)
	queue_updated = Signal()

Private Attributes
	_count
	_current_index
	_last_message_time
	_mutex
	_paused_queue
	_queue
	_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 44 of file timeline.py.

Constructor & Destructor Documentation

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

Definition at line 54 of file timeline.py.

Member Function Documentation

def rqt_robot_monitor.timeline.Timeline.__iter__

(

self

)

Definition at line 192 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.__len__

(

self

)

Definition at line 188 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 105 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 140 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.get_all_status_by_name	(		self,
			name
	)

Definition at line 181 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.get_current_status_by_name	(		self,
			name
	)

Definition at line 177 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 147 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.paused

(

self

)

True if this timeline is paused 

Definition at line 100 of file timeline.py.

def rqt_robot_monitor.timeline.Timeline.position

(

self

)

Definition at line 152 of file timeline.py.

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

Definition at line 162 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 79 of file timeline.py.

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

Definition at line 173 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 71 of file timeline.py.

Member Data Documentation

rqt_robot_monitor.timeline.Timeline._count

private

Definition at line 58 of file timeline.py.

rqt_robot_monitor.timeline.Timeline._current_index

private

Definition at line 59 of file timeline.py.

rqt_robot_monitor.timeline.Timeline._last_message_time

private

Definition at line 66 of file timeline.py.

rqt_robot_monitor.timeline.Timeline._mutex

private

Definition at line 56 of file timeline.py.

rqt_robot_monitor.timeline.Timeline._paused_queue

private

Definition at line 64 of file timeline.py.

rqt_robot_monitor.timeline.Timeline._queue

private

Definition at line 57 of file timeline.py.

rqt_robot_monitor.timeline.Timeline._subscriber

private

Definition at line 68 of file timeline.py.

rqt_robot_monitor.timeline.Timeline.message_updated = Signal(dict)

static

Definition at line 49 of file timeline.py.

rqt_robot_monitor.timeline.Timeline.pause_changed = Signal(bool)

static

Definition at line 51 of file timeline.py.

rqt_robot_monitor.timeline.Timeline.position

Definition at line 127 of file timeline.py.

rqt_robot_monitor.timeline.Timeline.position_changed = Signal(int)

static

Definition at line 52 of file timeline.py.

rqt_robot_monitor.timeline.Timeline.queue_updated = Signal()

static

Definition at line 50 of file timeline.py.

---

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

• timeline.py