Public Member Functions | Public Attributes | Private Attributes | List of all members
rqt_bag.player.Player Class Reference
Inheritance diagram for rqt_bag.player.Player:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, timeline)
 
def create_publisher (self, topic, msg)
 
def event (self, event)
 
def is_publishing (self, topic)
 
def message_cleared (self)
 
def message_viewed (self, bag, msg_data)
 
def resume (self)
 
def start_clock_publishing (self)
 
def start_publishing (self, topic)
 
def stop (self)
 
def stop_clock_publishing (self)
 
def stop_publishing (self, topic)
 

Public Attributes

 timeline
 

Private Attributes

 _last_clock
 
 _publish_clock
 
 _publishers
 
 _publishing
 
 _resume
 

Detailed Description

This object handles publishing messages as the playhead passes over their position

Definition at line 45 of file player.py.

Constructor & Destructor Documentation

◆ __init__()

def rqt_bag.player.Player.__init__ (   self,
  timeline 
)

Definition at line 51 of file player.py.

Member Function Documentation

◆ create_publisher()

def rqt_bag.player.Player.create_publisher (   self,
  topic,
  msg 
)

Definition at line 101 of file player.py.

◆ event()

def rqt_bag.player.Player.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 144 of file player.py.

◆ is_publishing()

def rqt_bag.player.Player.is_publishing (   self,
  topic 
)

Definition at line 65 of file player.py.

◆ message_cleared()

def rqt_bag.player.Player.message_cleared (   self)

Definition at line 141 of file player.py.

◆ message_viewed()

def rqt_bag.player.Player.message_viewed (   self,
  bag,
  msg_data 
)
When a message is viewed publish it
:param bag: the bag the message is in, ''rosbag.bag''
:param msg_data: tuple of the message data and topic info, ''(str, msg)''

Definition at line 116 of file player.py.

◆ resume()

def rqt_bag.player.Player.resume (   self)

Definition at line 62 of file player.py.

◆ start_clock_publishing()

def rqt_bag.player.Player.start_clock_publishing (   self)

Definition at line 85 of file player.py.

◆ start_publishing()

def rqt_bag.player.Player.start_publishing (   self,
  topic 
)

Definition at line 68 of file player.py.

◆ stop()

def rqt_bag.player.Player.stop (   self)

Definition at line 96 of file player.py.

◆ stop_clock_publishing()

def rqt_bag.player.Player.stop_clock_publishing (   self)

Definition at line 90 of file player.py.

◆ stop_publishing()

def rqt_bag.player.Player.stop_publishing (   self,
  topic 
)

Definition at line 74 of file player.py.

Member Data Documentation

◆ _last_clock

rqt_bag.player.Player._last_clock
private

Definition at line 59 of file player.py.

◆ _publish_clock

rqt_bag.player.Player._publish_clock
private

Definition at line 58 of file player.py.

◆ _publishers

rqt_bag.player.Player._publishers
private

Definition at line 56 of file player.py.

◆ _publishing

rqt_bag.player.Player._publishing
private

Definition at line 55 of file player.py.

◆ _resume

rqt_bag.player.Player._resume
private

Definition at line 60 of file player.py.

◆ timeline

rqt_bag.player.Player.timeline

Definition at line 53 of file player.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 Thu Mar 2 2023 03:43:15