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

Public Member Functions

def __init__ (self, filename, bag_lock=None, all=True, topics=[], regex=False, limit=0, master_check_interval=1.0)
 
def add_listener (self, listener)
 
def bag (self)
 
def pause (self)
 
def paused (self)
 
def start (self)
 
def stop (self)
 
def toggle_paused (self)
 
def unpause (self)
 

Private Member Functions

def _record (self, topic, m)
 
def _run_master_check (self)
 
def _run_write (self)
 
def _should_subscribe_to (self, topic)
 
def _unsubscribe (self, topic)
 

Private Attributes

 _all
 
 _bag
 
 _bag_lock
 
 _failed_topics
 
 _last_update
 
 _limit
 
 _limited_topics
 
 _listeners
 
 _master_check_interval
 
 _master_check_thread
 
 _message_count
 
 _paused
 
 _regex
 
 _regexes
 
 _stop_condition
 
 _stop_flag
 
 _subscriber_helpers
 
 _topics
 
 _write_queue
 
 _write_thread
 

Detailed Description

Definition at line 54 of file recorder.py.

Constructor & Destructor Documentation

def rqt_bag.recorder.Recorder.__init__ (   self,
  filename,
  bag_lock = None,
  all = True,
  topics = [],
  regex = False,
  limit = 0,
  master_check_interval = 1.0 
)
Subscribe to ROS messages and record them to a bag file.

@param filename: filename of bag to write to
@type  filename: str
@param all: all topics are to be recorded [default: True]
@type  all: bool
@param topics: topics (or regexes if regex is True) to record [default: empty list]
@type  topics: list of str
@param regex: topics should be considered as regular expressions [default: False]
@type  regex: bool
@param limit: record only this number of messages on each topic (if non-positive, then unlimited) [default: 0]
@type  limit: int
@param master_check_interval: period (in seconds) to check master for new topic publications [default: 1]
@type  master_check_interval: float

Definition at line 56 of file recorder.py.

Member Function Documentation

def rqt_bag.recorder.Recorder._record (   self,
  topic,
  m 
)
private

Definition at line 210 of file recorder.py.

def rqt_bag.recorder.Recorder._run_master_check (   self)
private

Definition at line 146 of file recorder.py.

def rqt_bag.recorder.Recorder._run_write (   self)
private

Definition at line 222 of file recorder.py.

def rqt_bag.recorder.Recorder._should_subscribe_to (   self,
  topic 
)
private

Definition at line 189 of file recorder.py.

def rqt_bag.recorder.Recorder._unsubscribe (   self,
  topic 
)
private

Definition at line 202 of file recorder.py.

def rqt_bag.recorder.Recorder.add_listener (   self,
  listener 
)
Add a listener which gets called whenever a message is recorded.
@param listener: function to call
@type  listener: function taking (topic, message, time)

Definition at line 106 of file recorder.py.

def rqt_bag.recorder.Recorder.bag (   self)

Definition at line 103 of file recorder.py.

def rqt_bag.recorder.Recorder.pause (   self)

Definition at line 125 of file recorder.py.

def rqt_bag.recorder.Recorder.paused (   self)

Definition at line 122 of file recorder.py.

def rqt_bag.recorder.Recorder.start (   self)
Start subscribing and recording messages to bag.

Definition at line 114 of file recorder.py.

def rqt_bag.recorder.Recorder.stop (   self)
Stop recording.

Definition at line 134 of file recorder.py.

def rqt_bag.recorder.Recorder.toggle_paused (   self)

Definition at line 131 of file recorder.py.

def rqt_bag.recorder.Recorder.unpause (   self)

Definition at line 128 of file recorder.py.

Member Data Documentation

rqt_bag.recorder.Recorder._all
private

Definition at line 73 of file recorder.py.

rqt_bag.recorder.Recorder._bag
private

Definition at line 79 of file recorder.py.

rqt_bag.recorder.Recorder._bag_lock
private

Definition at line 80 of file recorder.py.

rqt_bag.recorder.Recorder._failed_topics
private

Definition at line 84 of file recorder.py.

rqt_bag.recorder.Recorder._last_update
private

Definition at line 85 of file recorder.py.

rqt_bag.recorder.Recorder._limit
private

Definition at line 76 of file recorder.py.

rqt_bag.recorder.Recorder._limited_topics
private

Definition at line 83 of file recorder.py.

rqt_bag.recorder.Recorder._listeners
private

Definition at line 81 of file recorder.py.

rqt_bag.recorder.Recorder._master_check_interval
private

Definition at line 77 of file recorder.py.

rqt_bag.recorder.Recorder._master_check_thread
private

Definition at line 99 of file recorder.py.

rqt_bag.recorder.Recorder._message_count
private

Definition at line 97 of file recorder.py.

rqt_bag.recorder.Recorder._paused
private

Definition at line 87 of file recorder.py.

rqt_bag.recorder.Recorder._regex
private

Definition at line 75 of file recorder.py.

rqt_bag.recorder.Recorder._regexes
private

Definition at line 93 of file recorder.py.

rqt_bag.recorder.Recorder._stop_condition
private

Definition at line 88 of file recorder.py.

rqt_bag.recorder.Recorder._stop_flag
private

Definition at line 89 of file recorder.py.

rqt_bag.recorder.Recorder._subscriber_helpers
private

Definition at line 82 of file recorder.py.

rqt_bag.recorder.Recorder._topics
private

Definition at line 74 of file recorder.py.

rqt_bag.recorder.Recorder._write_queue
private

Definition at line 86 of file recorder.py.

rqt_bag.recorder.Recorder._write_thread
private

Definition at line 100 of file recorder.py.


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


rqt_bag
Author(s): Aaron Blasdel, Tim Field
autogenerated on Fri Jun 7 2019 22:05:54