Inheritance diagram for rqt_bag.bag_timeline.BagTimeline:

Public Member Functions
def	__init__
def	add_bag
def	add_listener
def	add_view
	Views / listeners.
def	copy_region_to_bag
def	get_context
def	get_datatype
def	get_entries
def	get_entries_with_bags
def	get_entry
def	get_entry_after
def	get_entry_before
def	get_next_message_time
def	get_previous_message_time
def	handle_close
def	has_listeners
def	is_publishing
	Publishing.
def	navigate_end
def	navigate_fastforward
def	navigate_next
def	navigate_play
def	navigate_previous
def	navigate_rewind
def	navigate_start
def	navigate_stop
def	on_idle
	Playing.
def	on_mouse_down
	Mouse events.
def	on_mouse_move
def	on_mouse_up
def	on_mousewheel
def	read_message
def	record_bag
	Recording.
def	remove_listener
def	reset_zoom
def	set_publishing_state
def	start_background_task
	Copy messages to...
def	start_publishing
def	step_fixed
def	step_next_message
def	stop_background_task
def	stop_publishing
def	toggle_play
def	toggle_play_all
def	toggle_recording
def	translate_timeline_left
def	translate_timeline_right
def	zoom_in
def	zoom_out
Public Attributes
	background_progress
	background_task
	background_task_cancel
	desired_playhead
	last_frame
	last_playhead
	popups
	stick_to_end
	wrap
Static Public Attributes
tuple	selected_region_changed = Signal(rospy.Time, rospy.Time)
tuple	status_bar_changed_signal = Signal()
Properties
	play_all = property(_get_play_all, _set_play_all)
	play_speed = property(_get_play_speed, _set_play_speed)
Private Member Functions
def	_create_player
def	_export_region
def	_get_end_stamp
def	_get_play_all
def	_get_play_speed
	Playhead.
def	_get_start_stamp
def	_get_topics
def	_get_topics_by_datatype
def	_message_recorded
def	_run_export_region
def	_set_play_all
def	_set_play_speed
def	_step_playhead
Private Attributes
	__closed
	_bag_lock
	_bags
	_context
	_export_thread
	_listeners
	_max_play_speed
	_message_listener_threads
	_message_loaders
	_messages
	_messages_cvs
	_min_play_speed
	_play_all
	_play_speed
	_play_timer
	_player
	_playhead_lock
	_playhead_positions
	_playhead_positions_cvs
	_publish_clock
	_recorder
	_timeline_frame
	_views

Detailed Description

BagTimeline contains bag files, all information required to display the bag data visualization on the screen
Also handles events

Definition at line 52 of file bag_timeline.py.

Constructor & Destructor Documentation

def rqt_bag.bag_timeline.BagTimeline.__init__	(	self,
		context,
		publish_clock
	)

:param context: plugin context hook to enable adding rqt_bag plugin widgets as ROS_GUI snapin panes, ''PluginContext''

Definition at line 60 of file bag_timeline.py.

Member Function Documentation

def rqt_bag.bag_timeline.BagTimeline._create_player ( self ) [private]

Definition at line 529 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._export_region	(	self,
		path,
		topics,
		start_stamp,
		end_stamp
	)	`[private]`

Starts a thread to save the current selection to a new bag file
:param path: filesystem path to write to, ''str''
:param topics: topics to write to the file, ''list(str)''
:param start_stamp: start of area to save, ''rospy.Time''
:param end_stamp: end of area to save, ''rospy.Time''

Definition at line 390 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._get_end_stamp ( self ) [private]

:return: last stamp in the bags, ''rospy.Time''

Definition at line 191 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._get_play_all ( self ) [private]

Definition at line 551 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._get_play_speed ( self ) [private]

Playhead.

Definition at line 754 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._get_start_stamp ( self ) [private]

:return: first stamp in the bags, ''rospy.Time''

Definition at line 179 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._get_topics ( self ) [private]

:return: sorted list of topic names, ''list(str)''

Definition at line 203 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._get_topics_by_datatype ( self ) [private]

:return: dict of list of topics for each datatype, ''dict(datatype:list(topic))''

Definition at line 214 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._message_recorded	(	self,
		topic,
		msg,
		t
	)	`[private]`

Definition at line 688 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._run_export_region	(	self,
		export_bag,
		topics,
		start_stamp,
		end_stamp,
		bag_entries
	)	`[private]`

Threaded function that saves the current selection to a new bag file
:param export_bag: bagfile to write to, ''rosbag.bag''
:param topics: topics to write to the file, ''list(str)''
:param start_stamp: start of area to save, ''rospy.Time''
:param end_stamp: end of area to save, ''rospy.Time''

Definition at line 427 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._set_play_all	(	self,
		play_all
	)	`[private]`

Definition at line 554 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._set_play_speed	(	self,
		play_speed
	)	`[private]`

Definition at line 759 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline._step_playhead ( self ) [private]

moves the playhead to the next position based on the desired position

Definition at line 573 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.add_bag	(	self,
		bag
	)

creates an indexing thread for each new topic in the bag
fixes the boarders and notifies the indexing thread to index the new items bags
:param bag: ros bag file, ''rosbag.bag''

Definition at line 144 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.add_listener	(	self,
		topic,
		listener
	)

Definition at line 726 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.add_view	(	self,
		topic,
		frame
	)

Views / listeners.

Definition at line 720 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.copy_region_to_bag	(	self,
		filename
	)

Definition at line 386 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_context ( self )

:returns: the ROS_GUI context, 'PluginContext'

Definition at line 112 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_datatype	(	self,
		topic
	)

:return: datatype associated with a topic, ''str''
:raises: if there are multiple datatypes assigned to a single topic, ''Exception''

Definition at line 225 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_entries	(	self,
		topics,
		start_stamp,
		end_stamp
	)

generator function for bag entries
:param topics: list of topics to query, ''list(str)''
:param start_stamp: stamp to start at, ''rospy.Time''
:param end_stamp: stamp to end at, ''rospy,Time''
:returns: entries the bag file, ''msg''

Definition at line 240 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_entries_with_bags	(	self,
		topic,
		start_stamp,
		end_stamp
	)

generator function for bag entries
:param topics: list of topics to query, ''list(str)''
:param start_stamp: stamp to start at, ''rospy.Time''
:param end_stamp: stamp to end at, ''rospy,Time''
:returns: tuple of (bag, entry) for the entries in the bag file, ''(rosbag.bag, msg)''

Definition at line 266 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_entry	(	self,
		t,
		topic
	)

Access a bag entry
:param t: time, ''rospy.Time''
:param topic: the topic to be accessed, ''str''
:return: tuple of (bag, entry) corisponding to time t and topic, ''(rosbag.bag, msg)''

Definition at line 296 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_entry_after	(	self,
		t
	)

Access a bag entry
:param t: time, ''rospy.Time''
:return: tuple of (bag, entry) corisponding to time t, ''(rosbag.bag, msg)''

Definition at line 327 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_entry_before	(	self,
		t
	)

Access a bag entry
:param t: time, ''rospy.Time''
:return: tuple of (bag, entry) corresponding to time t, ''(rosbag.bag, msg)''

Definition at line 312 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_next_message_time ( self )

:return: time of the next message after the current playhead position,''rospy.Time''

Definition at line 342 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.get_previous_message_time ( self )

:return: time of the next message before the current playhead position,''rospy.Time''

Definition at line 355 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.handle_close ( self )

Cleans up the timeline, bag and any threads

Definition at line 118 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.has_listeners	(	self,
		topic
	)

Definition at line 723 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.is_publishing	(	self,
		topic
	)

Publishing.

Definition at line 512 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_end ( self )

Definition at line 825 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_fastforward ( self )

Definition at line 812 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_next ( self )

Definition at line 797 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_play ( self )

Definition at line 782 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_previous ( self )

Definition at line 792 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_rewind ( self )

Definition at line 802 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_start ( self )

Definition at line 822 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.navigate_stop ( self )

Definition at line 788 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.on_idle ( self )

Playing.

Definition at line 570 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.on_mouse_down	(	self,
		event
	)

Mouse events.

Definition at line 476 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.on_mouse_move	(	self,
		event
	)

Definition at line 488 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.on_mouse_up	(	self,
		event
	)

Definition at line 485 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.on_mousewheel	(	self,
		event
	)

Definition at line 491 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.read_message	(	self,
		bag,
		position
	)

Definition at line 471 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.record_bag	(	self,
		filename,
		all = `True`,
		topics = `[]`,
		regex = `False`,
		limit = `0`
	)

Recording.

Definition at line 665 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.remove_listener	(	self,
		topic,
		listener
	)

Definition at line 737 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.reset_zoom ( self )

Definition at line 502 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.set_publishing_state	(	self,
		start_publishing
	)

Definition at line 541 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.start_background_task	(	self,
		background_task
	)

Copy messages to...

Verify that a background task is not currently running before starting a new one
:param background_task: name of the background task, ''str''

Definition at line 370 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.start_publishing	(	self,
		topic
	)

Definition at line 515 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.step_fixed ( self )

Moves the playhead a fixed distance into the future based on the current play speed

Definition at line 588 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.step_next_message ( self )

Move the playhead to the next message

Definition at line 634 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.stop_background_task ( self )

Definition at line 383 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.stop_publishing	(	self,
		topic
	)

Definition at line 522 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.toggle_play ( self )

Definition at line 776 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.toggle_play_all ( self )

Definition at line 566 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.toggle_recording ( self )

Definition at line 683 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.translate_timeline_left ( self )

Definition at line 505 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.translate_timeline_right ( self )

Definition at line 508 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.zoom_in ( self )

Definition at line 496 of file bag_timeline.py.

def rqt_bag.bag_timeline.BagTimeline.zoom_out ( self )

Definition at line 499 of file bag_timeline.py.

Member Data Documentation

rqt_bag::bag_timeline.BagTimeline::__closed [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_bag_lock [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_bags [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_context [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_export_thread [private]

Definition at line 396 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_listeners [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_max_play_speed [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_message_listener_threads [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_message_loaders [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_messages [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_messages_cvs [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_min_play_speed [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_play_all [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_play_speed [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_play_timer [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_player [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_playhead_lock [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_playhead_positions [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_playhead_positions_cvs [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_publish_clock [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_recorder [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_timeline_frame [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::_views [private]

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::background_progress

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::background_task

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::background_task_cancel

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::desired_playhead

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::last_frame

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::last_playhead

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::popups

Definition at line 62 of file bag_timeline.py.

tuple rqt_bag::bag_timeline.BagTimeline::selected_region_changed = Signal(rospy.Time, rospy.Time) [static]

Definition at line 58 of file bag_timeline.py.

tuple rqt_bag::bag_timeline.BagTimeline::status_bar_changed_signal = Signal() [static]

Definition at line 57 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::stick_to_end

Definition at line 62 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::wrap

Definition at line 62 of file bag_timeline.py.

Property Documentation

rqt_bag::bag_timeline.BagTimeline::play_all = property(_get_play_all, _set_play_all) [static]

Definition at line 564 of file bag_timeline.py.

rqt_bag::bag_timeline.BagTimeline::play_speed = property(_get_play_speed, _set_play_speed) [static]

Definition at line 774 of file bag_timeline.py.

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

bag_timeline.py

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation