Loading...
Searching...
No Matches
BaseBag Class Reference
ROS bag interface. More...
Inheritance diagram for BaseBag:
Public Member Functions | |
| __bool__ (self) | |
| __contains__ (self, key) | |
| Returns whether bag contains given topic. | |
| __copy__ (self) | |
| __deepcopy__ (self, memo=None) | |
| __enter__ (self) | |
| Context manager entry, opens bag if not open. | |
| __exit__ (self, exc_type, exc_value, traceback) | |
| Context manager exit, closes bag. | |
| __getitem__ (self, key) | |
| Returns an iterator yielding messages from the bag in given topic, supporting len(). | |
| __iter__ (self) | |
| Iterates over all messages in the bag. | |
| __len__ (self) | |
| Returns the number of messages in the bag. | |
| __next__ (self) | |
| Retrieves next message from bag as (topic, message, timestamp). | |
| __nonzero__ (self) | |
| __str__ (self) | |
| Returns informative text for bag, with a full overview of topics and types. | |
| close (self) | |
| Closes the bag file. | |
| flush (self) | |
| Ensures all changes are written to bag file. | |
| get_end_time (self) | |
| Returns the end time of the bag, as UNIX timestamp, or None if bag empty. | |
| get_message_class (self, typename, typehash=None) | |
| Returns ROS message type class, or None if unknown message type for bag. | |
| get_message_count (self, topic_filters=None) | |
| Returns the number of messages in the bag. | |
| get_message_definition (self, msg_or_type) | |
| Returns ROS message type definition full text, including subtype definitions. | |
| get_message_type_hash (self, msg_or_type) | |
| Returns ROS message type MD5 hash, or None if unknown message type for bag. | |
| get_qoses (self, topic, typename) | |
| Returns topic Quality-of-Service profiles as a list of dicts, or None if not available. | |
| get_start_time (self) | |
| Returns the start time of the bag, as UNIX timestamp, or None if bag empty. | |
| get_topic_info (self, counts=True) | |
| Returns topic and message type metainfo as {(topic, typename, typehash): count}. | |
| get_type_and_topic_info (self, topic_filters=None) | |
| Returns thorough metainfo on topic and message types. | |
| open (self) | |
| Opens the bag file if not already open. | |
| read_messages (self, topics=None, start_time=None, end_time=None, raw=False, **__) | |
| Yields messages from the bag, optionally filtered by topic and timestamp. | |
| write (self, topic, msg, t=None, raw=False, **kwargs) | |
| Writes a message to the bag. | |
Static Public Attributes | |
| BagMessage = collections.namedtuple("BagMessage", "topic message timestamp") | |
| Returned from read_messages() as (topic name, ROS message, ROS timestamp object). | |
| tuple | MODES = ("r", "w", "a") |
| Supported opening modes, overridden in subclasses. | |
| next | |
| bool | STREAMABLE = True |
| Whether bag supports reading or writing stream objects, overridden in subclasses. | |
| TopicTuple | |
| Returned from get_type_and_topic_info() as (typename, message count, connection count, median frequency). | |
| TypesAndTopicsTuple = collections.namedtuple("TypesAndTopicsTuple", ["msg_types", "topics"]) | |
| Returned from get_type_and_topic_info() as ({typename: typehash}, {topic name: TopicTuple}). | |
Properties | |
| closed = property | |
| Returns whether file is closed. | |
| filename = property | |
| Returns bag file path. | |
| mode = property | |
| Returns file open mode. | |
| size = property | |
| Returns current file size in bytes. | |
| stop_on_error = property | |
| Whether raising read error on unknown message type (ROS2 SQLite .db3 specific). | |
| topics = property | |
| Returns the list of topics in bag, in alphabetic order. | |
Detailed Description
ROS bag interface.
Bag can be used a context manager, is an iterable providing (topic, message, timestamp) tuples and supporting len(bag); and supports topic-based membership (if mytopic in bag, for t, m, s in bag[mytopic], len(bag[mytopic])).
Extra methods and properties compared with rosbag.Bag: Bag.get_message_class(),
Bag.get_message_definition(), Bag.get_message_type_hash(), Bag.get_topic_info();
Bag.closed and Bag.topics.
Member Function Documentation
◆ __bool__()
◆ __contains__()
| __contains__ | ( | self, | |
| key | |||
| ) |
◆ __copy__()
◆ __deepcopy__()
◆ __enter__()
| __enter__ | ( | self | ) |
◆ __exit__()
| __exit__ | ( | self, | |
| exc_type, | |||
| exc_value, | |||
| traceback | |||
| ) |
◆ __getitem__()
| __getitem__ | ( | self, | |
| key | |||
| ) |
◆ __iter__()
◆ __len__()
◆ __next__()
| __next__ | ( | self | ) |
◆ __nonzero__()
◆ __str__()
| __str__ | ( | self | ) |
◆ close()
| close | ( | self | ) |
◆ flush()
◆ get_end_time()
| get_end_time | ( | self | ) |
◆ get_message_class()
| get_message_class | ( | self, | |
| typename, | |||
typehash = None |
|||
| ) |
◆ get_message_count()
| get_message_count | ( | self, | |
topic_filters = None |
|||
| ) |
Returns the number of messages in the bag.
- Parameters
-
topic_filters list of topics or a single topic to filter by, if any
Reimplemented in EmbagReader, McapBag, and ROS2Bag.
◆ get_message_definition()
| get_message_definition | ( | self, | |
| msg_or_type | |||
| ) |
◆ get_message_type_hash()
| get_message_type_hash | ( | self, | |
| msg_or_type | |||
| ) |
◆ get_qoses()
| get_qoses | ( | self, | |
| topic, | |||
| typename | |||
| ) |
◆ get_start_time()
| get_start_time | ( | self | ) |
◆ get_topic_info()
| get_topic_info | ( | self, | |
counts = True |
|||
| ) |
◆ get_type_and_topic_info()
| get_type_and_topic_info | ( | self, | |
topic_filters = None |
|||
| ) |
Returns thorough metainfo on topic and message types.
- Parameters
-
topic_filters list of topics or a single topic to filter returned topics-dict by, if any
- Returns
- TypesAndTopicsTuple(msg_types, topics) namedtuple, msg_types as dict of {typename: typehash}, topics as a dict of {topic: TopicTuple() namedtuple}.
Reimplemented in EmbagReader, McapBag, and ROS2Bag.
◆ open()
| open | ( | self | ) |
◆ read_messages()
| read_messages | ( | self, | |
topics = None, |
|||
start_time = None, |
|||
end_time = None, |
|||
raw = False, |
|||
| ** | __ | ||
| ) |
Yields messages from the bag, optionally filtered by topic and timestamp.
- Parameters
-
topics list of topics or a single topic to filter by, if any start_time earliest timestamp of message to return, as ROS time or convertible (int/float/duration/datetime/decimal)end_time latest timestamp of message to return, as ROS time (int/float/duration/datetime/decimal)raw if true, then returned messages are tuples of or (typename, bytes, typehash, position, typeclass), depending on file format(typename, bytes, typehash, typeclass)
- Returns
- BagMessage namedtuples of (topic, message, timestamp as ROS time)
Reimplemented in EmbagReader, McapBag, ROS2Bag, and ROS1Bag.
◆ write()
| write | ( | self, | |
| topic, | |||
| msg, | |||
t = None, |
|||
raw = False, |
|||
| ** | kwargs | ||
| ) |
Writes a message to the bag.
- Parameters
-
topic name of topic msg ROS message t message timestamp if not using current wall time, as ROS time or convertible (int/float/duration/datetime/decimal) raw if true, msgis in raw format, (typename, bytes, typehash, typeclass)kwargs ROS version-specific arguments, like connection_headerfor ROS1 orqosesfor ROS2
Member Data Documentation
◆ BagMessage
|
static |
◆ MODES
|
static |
◆ next
◆ STREAMABLE
|
static |
◆ TopicTuple
|
static |
◆ TypesAndTopicsTuple
|
static |
Property Documentation
◆ closed
◆ filename
◆ mode
◆ size
◆ stop_on_error
|
static |
◆ topics
|
static |
The documentation for this class was generated from the following file:
- grepros/api.py
