Public Member Functions | Public Attributes | Static Public Attributes | List of all members
rqt_bag.plugins.message_view.MessageView Class Reference
Inheritance diagram for rqt_bag.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, bag, 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_bag.plugins.message_view.MessageView.__init__ (   self,
  timeline,
  topic 
)

Definition at line 45 of file message_view.py.

Member Function Documentation

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

Definition at line 79 of file message_view.py.

def rqt_bag.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 86 of file message_view.py.

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

Definition at line 66 of file message_view.py.

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

@param bag: the bag file the message is contained in
@type  bag: rosbag.Bag
@param msg_details: the details of the message to be viewed
@type msg_details: tuple (topic, msg, time)
    @param topic: the message topic
    @type  topic: str
    @param msg: the message
    @param t: the message timestamp
    @type  t: rospy.Time

Definition at line 50 of file message_view.py.

def rqt_bag.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 72 of file message_view.py.

Member Data Documentation

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

Definition at line 43 of file message_view.py.

rqt_bag.plugins.message_view.MessageView.timeline

Definition at line 47 of file message_view.py.

rqt_bag.plugins.message_view.MessageView.topic

Definition at line 48 of file message_view.py.


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


rqt_bag
Author(s): Dirk Thomas , Aaron Blasdel , Austin Hendrix , Tim Field
autogenerated on Fri Feb 19 2021 03:14:14