Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
rqt_robot_monitor.robot_monitor.RobotMonitorWidget Class Reference
Inheritance diagram for rqt_robot_monitor.robot_monitor.RobotMonitorWidget:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, context, topic=None)
 
def message_updated (self, status)
 
def queue_updated (self)
 
def resizeEvent (self, evt)
 
def restore_settings (self, plugin_settings, instance_settings)
 
def save_settings (self, plugin_settings, instance_settings)
 
def shutdown (self)
 

Private Member Functions

def _inspector_closed (self, name)
 
def _signal_message_updated (self, status)
 
def _signal_queue_updated (self)
 
def _tree_clicked (self, item, column)
 
def _update_background_color (self)
 
def _update_message_state (self)
 

Private Attributes

 _err_tree
 
 _inspectors
 
 _is_stale
 
 _message_updated_processing
 
 _original_alt_base_color
 
 _original_base_color
 
 _queue_updated_processing
 
 _timeline
 
 _timeline_pane
 
 _timer
 
 _tree
 
 _warn_tree
 

Static Private Attributes

 _message_updated = Signal(dict)
 
 _queue_updated = Signal()
 
int _TREE_ALL = 1
 
int _TREE_ERR = 3
 
int _TREE_WARN = 2
 

Detailed Description

NOTE: RobotMonitorWidget.shutdown function needs to be called
when the instance of this class terminates.

RobotMonitorWidget itself doesn't store previous diagnostic states.
It instead delegates that function to Timeline class.

Definition at line 52 of file robot_monitor.py.

Constructor & Destructor Documentation

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget.__init__ (   self,
  context,
  topic = None 
)
:param context: plugin context hook to enable adding widgets as a
        ROS_GUI pane, 'PluginContext'
:param topic: Diagnostic topic to subscribe to 'str'

Definition at line 68 of file robot_monitor.py.

Member Function Documentation

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget._inspector_closed (   self,
  name 
)
private
Called when an inspector window is closed 

Definition at line 217 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget._signal_message_updated (   self,
  status 
)
private
DiagnosticArray message callback 

Definition at line 148 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget._signal_queue_updated (   self)
private

Definition at line 202 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget._tree_clicked (   self,
  item,
  column 
)
private
Slot to QTreeWidget.itemDoubleClicked

:type item: QTreeWidgetItem
:type column: int

Definition at line 223 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget._update_background_color (   self)
private
Update the background color based on staleness 

Definition at line 261 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget._update_message_state (   self)
private
Update the display if it's stale 

Definition at line 240 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget.message_updated (   self,
  status 
)
This method just calls _signal_message_updated in 'best effort' manner.
This method should be called by signal with DirectConnection.

Definition at line 137 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget.queue_updated (   self)
This method just calls _signal_queue_updated in 'best effort' manner.
This method should be called by signal with DirectConnection.

Definition at line 191 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget.resizeEvent (   self,
  evt 
)
Overridden from QWidget

Definition at line 210 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget.restore_settings (   self,
  plugin_settings,
  instance_settings 
)

Definition at line 297 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget.save_settings (   self,
  plugin_settings,
  instance_settings 
)

Definition at line 292 of file robot_monitor.py.

def rqt_robot_monitor.robot_monitor.RobotMonitorWidget.shutdown (   self)
This needs to be called whenever this class terminates.
This closes all the instances on all trees.
Also unregisters ROS' subscriber, stops timer.

Definition at line 274 of file robot_monitor.py.

Member Data Documentation

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._err_tree
private

Definition at line 134 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._inspectors
private

Definition at line 115 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._is_stale
private

Definition at line 122 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._message_updated = Signal(dict)
staticprivate

Definition at line 65 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._message_updated_processing
private

Definition at line 85 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._original_alt_base_color
private

Definition at line 130 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._original_base_color
private

Definition at line 129 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._queue_updated = Signal()
staticprivate

Definition at line 66 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._queue_updated_processing
private

Definition at line 86 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._timeline
private

Definition at line 92 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._timeline_pane
private

Definition at line 103 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._timer
private

Definition at line 124 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._tree
private

Definition at line 132 of file robot_monitor.py.

int rqt_robot_monitor.robot_monitor.RobotMonitorWidget._TREE_ALL = 1
staticprivate

Definition at line 61 of file robot_monitor.py.

int rqt_robot_monitor.robot_monitor.RobotMonitorWidget._TREE_ERR = 3
staticprivate

Definition at line 63 of file robot_monitor.py.

int rqt_robot_monitor.robot_monitor.RobotMonitorWidget._TREE_WARN = 2
staticprivate

Definition at line 62 of file robot_monitor.py.

rqt_robot_monitor.robot_monitor.RobotMonitorWidget._warn_tree
private

Definition at line 133 of file robot_monitor.py.


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


rqt_robot_monitor
Author(s): Austin Hendrix, Isaac Saito, Ze'ev Klapow, Kevin Watts, Josh Faust
autogenerated on Thu Jun 4 2020 03:46:53