rqt_robot_monitor.time_pane.TimelinePane Class Reference

Inheritance diagram for rqt_robot_monitor.time_pane.TimelinePane:

List of all members.

Public Member Functions
def	__init__
def	get_diagnostic_queue
def	get_worst
def	mouse_release
def	new_diagnostic
def	on_slider_scroll
def	redraw
Private Member Functions
def	_pause
Private Attributes
	_last_msg
	_last_sec_marker_at
	_len_timeline
	_msg_callback
	_parent
	_pause_callback
	_paused
	_queue_diagnostic
	_scene
	_tracking_latest
Static Private Attributes
tuple	_sig_update = Signal()

---

Detailed Description

This class defines the pane where timeline, button, message are displayed. 

Definition at line 48 of file time_pane.py.

---

Constructor & Destructor Documentation

def rqt_robot_monitor.time_pane.TimelinePane.__init__	(		self,
			parent,
			len_timeline,
			msg_callback,
			color_callback,
			pause_callback = None
	)

@param msg_callback: This can be a function that takes either 
{ DiagnosticArray, DiagnosticsStatus } as an argument. If your timeline
is to show the status of all devices, choose the former. 
Else (eg. your timeline only handles the status of an arbitrary 
node) use the latter.     

@param color_callback: Not directly used within this class. Instead,
this will be passed and used in TimelineView class.

@todo: pause_callback is MUST since it's used in both by
 RobotMonitorWidget & InspectorWindow. 

Definition at line 55 of file time_pane.py.

---

Member Function Documentation

def rqt_robot_monitor.time_pane.TimelinePane._pause	(		self,
			paused
	)		[private]

Should be the only interface for 
pausing timeline pane and timeline itself (which is not as of now..).

@todo: Think about optimal way to call functions in parent class
(pause, _unpause). Use callback or just calling via parent instance?

@param paused: bool

Definition at line 140 of file time_pane.py.

def rqt_robot_monitor.time_pane.TimelinePane.get_diagnostic_queue

(

self

)

@return: a queue that contains either DiagnosticArray or 
DiagnosticsStatus. Depends on the purpose.
  
Copied from robot_monitor.        

Definition at line 250 of file time_pane.py.

def rqt_robot_monitor.time_pane.TimelinePane.get_worst	(		self,
			msg
	)

Definition at line 133 of file time_pane.py.

def rqt_robot_monitor.time_pane.TimelinePane.mouse_release	(		self,
			event
	)

@param event: QMouseEvent 

Definition at line 107 of file time_pane.py.

def rqt_robot_monitor.time_pane.TimelinePane.new_diagnostic	(		self,
			msg
	)

Callback for new msg for TimelinePane class.

Puts new msg into a queue, update the length of timeline. Also emits
a signal to notify another callbacks.        
This ignores new msg if timeline is paused.

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

Copied from robot_monitor.

Definition at line 207 of file time_pane.py.

def rqt_robot_monitor.time_pane.TimelinePane.on_slider_scroll	(		self,
			evt
	)

Copied from robot_monitor.

@param evt: QMouseEvent 

Definition at line 171 of file time_pane.py.

def rqt_robot_monitor.time_pane.TimelinePane.redraw

(

self

)

Definition at line 247 of file time_pane.py.

---

Member Data Documentation

rqt_robot_monitor::time_pane.TimelinePane::_last_msg [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_last_sec_marker_at [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_len_timeline [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_msg_callback [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_parent [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_pause_callback [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_paused [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_queue_diagnostic [private]

Definition at line 68 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_scene [private]

Definition at line 68 of file time_pane.py.

tuple rqt_robot_monitor::time_pane.TimelinePane::_sig_update = Signal() [static, private]

Definition at line 53 of file time_pane.py.

rqt_robot_monitor::time_pane.TimelinePane::_tracking_latest [private]

Definition at line 68 of file time_pane.py.

---

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

• time_pane.py