message_view.py
Go to the documentation of this file.00001 # Software License Agreement (BSD License) 00002 # 00003 # Copyright (c) 2009, 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 PKG = 'rxbag' 00034 import roslib; roslib.load_manifest(PKG) 00035 00036 class MessageView(object): 00037 """ 00038 A message details renderer. When registered with rxbag, a MessageView is called 00039 whenever the timeline playhead moves. 00040 """ 00041 name = 'Untitled' 00042 00043 def __init__(self, timeline): 00044 self.timeline = timeline 00045 00046 def message_viewed(self, bag, topic, msg, t): 00047 """ 00048 View the message. 00049 00050 @param bag: the bag file the message is contained in 00051 @type bag: rosbag.Bag 00052 @param topic: the message topic 00053 @type topic: str 00054 @param msg: the message 00055 @param t: the message timestamp 00056 @type t: rospy.Time 00057 """ 00058 pass 00059 00060 def message_cleared(self): 00061 """ 00062 Clear the currently viewed message (if any). 00063 """ 00064 pass 00065 00066 def timeline_changed(self): 00067 """ 00068 Called when the messages in a timeline change, e.g. if a new message is recorded, or 00069 a bag file is added 00070 """ 00071 pass 00072 00073 def close(self): 00074 """ 00075 Close the message view, releasing any resources. 00076 """ 00077 pass