message_view.py
Go to the documentation of this file.
00001 # Software License Agreement (BSD License)
00002 #
00003 # Copyright (c) 2012, Willow Garage, Inc.
00004 # All rights reserved.
00005 #
00006 # Redistribution and use in source and binary forms, with or without
00007 # modification, are permitted provided that the following conditions
00008 # are met:
00009 #
00010 #  * Redistributions of source code must retain the above copyright
00011 #    notice, this list of conditions and the following disclaimer.
00012 #  * Redistributions in binary form must reproduce the above
00013 #    copyright notice, this list of conditions and the following
00014 #    disclaimer in the documentation and/or other materials provided
00015 #    with the distribution.
00016 #  * Neither the name of Willow Garage, Inc. nor the names of its
00017 #    contributors may be used to endorse or promote products derived
00018 #    from this software without specific prior written permission.
00019 #
00020 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00024 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00027 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00028 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00029 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00030 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00031 # POSSIBILITY OF SUCH DAMAGE.
00032 
00033 
00034 from python_qt_binding.QtCore import QObject
00035 
00036 
00037 class MessageView(QObject):
00038     """
00039     A message details renderer. When registered with rqt_bag, a MessageView is called
00040     whenever the timeline playhead moves.
00041     """
00042     name = 'Untitled'
00043 
00044     def __init__(self, timeline):
00045         super(MessageView, self).__init__()
00046         self.timeline = timeline
00047 
00048     def message_viewed(self, bag, msg_details):
00049         """
00050         View the message.
00051 
00052         @param bag: the bag file the message is contained in
00053         @type  bag: rosbag.Bag
00054         @param msg_details: the details of the message to be viewed
00055         @type msg_details: tuple (topic, msg, time)
00056             @param topic: the message topic
00057             @type  topic: str
00058             @param msg: the message
00059             @param t: the message timestamp
00060             @type  t: rospy.Time
00061         """
00062         pass
00063 
00064     def message_cleared(self):
00065         """
00066         Clear the currently viewed message (if any).
00067         """
00068         pass
00069 
00070     def timeline_changed(self):
00071         """
00072         Called when the messages in a timeline change, e.g. if a new message is recorded, or
00073         a bag file is added
00074         """
00075         pass
00076 
00077     def close(self):
00078         """
00079         Close the message view, releasing any resources.
00080         """
00081         pass
00082 
00083 # NOTE: event function should not be changed in subclasses
00084     def event(self, event):
00085         """
00086         This function will be called to process events posted by post_event
00087         it will call message_cleared or message_viewed with the relevant data
00088         """
00089         bag, msg_data = event.data
00090         if msg_data:
00091             self.message_viewed(bag, msg_data)
00092         else:
00093             self.message_cleared()
00094         return True


rqt_bag
Author(s): Aaron Blasdel
autogenerated on Fri Jan 3 2014 11:55:06