Public Member Functions | Public Attributes | Static Public Attributes | List of all members
rqt_py_trees.plugins.message_view.MessageView Class Reference
Inheritance diagram for rqt_py_trees.plugins.message_view.MessageView:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, timeline, topic)
 
def close (self)
 
def event (self, event)
 
def message_cleared (self)
 
def message_viewed (self, msg_details)
 
def timeline_changed (self)
 

Public Attributes

 timeline
 
 topic
 

Static Public Attributes

string name = 'Untitled'
 

Detailed Description

A message details renderer. When registered with rqt_bag, a MessageView is called
whenever the timeline playhead moves.

Definition at line 37 of file message_view.py.

Constructor & Destructor Documentation

def rqt_py_trees.plugins.message_view.MessageView.__init__ (   self,
  timeline,
  topic 
)

Definition at line 44 of file message_view.py.

Member Function Documentation

def rqt_py_trees.plugins.message_view.MessageView.close (   self)
Close the message view, releasing any resources.

Definition at line 72 of file message_view.py.

def rqt_py_trees.plugins.message_view.MessageView.event (   self,
  event 
)
This function will be called to process events posted by post_event
it will call message_cleared or message_viewed with the relevant data

Definition at line 79 of file message_view.py.

def rqt_py_trees.plugins.message_view.MessageView.message_cleared (   self)
Clear the currently viewed message (if any).

Definition at line 59 of file message_view.py.

def rqt_py_trees.plugins.message_view.MessageView.message_viewed (   self,
  msg_details 
)
View the message.

:param msg_details: the details of the message to be viewed
:type msg_details: Message namedtuple (stamp, message). Stamp is the
    timestamp, message is the message received

Definition at line 49 of file message_view.py.

def rqt_py_trees.plugins.message_view.MessageView.timeline_changed (   self)
Called when the messages in a timeline change, e.g. if a new message is recorded, or
a bag file is added

Definition at line 65 of file message_view.py.

Member Data Documentation

string rqt_py_trees.plugins.message_view.MessageView.name = 'Untitled'
static

Definition at line 42 of file message_view.py.

rqt_py_trees.plugins.message_view.MessageView.timeline

Definition at line 46 of file message_view.py.

rqt_py_trees.plugins.message_view.MessageView.topic

Definition at line 47 of file message_view.py.


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


rqt_py_trees
Author(s): Thibault Kruse, Michal Staniaszek, Daniel Stonier, Naveed Usmani
autogenerated on Mon Jun 10 2019 14:55:56