rqt_bag.plugins.message_view.MessageView Class Reference

Inheritance diagram for rqt_bag.plugins.message_view.MessageView:

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

__init__()

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

Definition at line 45 of file message_view.py.

Member Function Documentation

close()

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.

event()

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.

message_cleared()

def rqt_bag.plugins.message_view.MessageView.message_cleared

(

self

)

Clear the currently viewed message (if any).

Reimplemented in rqt_bag.plugins.raw_view.RawView.

Definition at line 66 of file message_view.py.

message_viewed()

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

Reimplemented in rqt_bag.plugins.topic_message_view.TopicMessageView, and rqt_bag.plugins.raw_view.RawView.

Definition at line 50 of file message_view.py.

timeline_changed()

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

name

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

static

Definition at line 43 of file message_view.py.

timeline

rqt_bag.plugins.message_view.MessageView.timeline

Definition at line 47 of file message_view.py.

topic

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:

• message_view.py