niryo_libraries.rosbag.bag

module documentation

The rosbag Python API.

Provides serialization of bag files.

Class	`Bag`	Bag serialize messages to and from a single file on disk using the bag format.
Class	`ComparableMixin`	Undocumented
Class	`Compression`	Allowable compression types
Exception	`ROSBagEncryptException`	Exception raised when encryption or decryption failed.
Exception	`ROSBagEncryptNotSupportedException`	Exception raised when encryption is not supported.
Exception	`ROSBagException`	Base class for exceptions in rosbag.
Exception	`ROSBagFormatException`	Exceptions for errors relating to the bag file format.
Exception	`ROSBagUnindexedException`	Exception for unindexed bags.
Variable	`BagMessage`	Undocumented
Variable	`BagMessageWithConnectionHeader`	Undocumented
Variable	`found_lz4`	Undocumented
Class	`_BagReader`	Undocumented
Class	`_BagReader102_Indexed`	Support class for reading indexed v1.2 bag files.
Class	`_BagReader102_Unindexed`	Support class for reading unindexed v1.2 bag files.
Class	`_BagReader200`	Support class for reading v2.0 bag files.
Class	`_ChunkHeader`	Undocumented
Class	`_ChunkInfo`	Undocumented
Class	`_CompressorFileFacade`	A file facade for sequential compressors (e.g., bz2.BZ2Compressor).
Class	`_ConnectionInfo`	Undocumented
Class	`_IndexEntry`	Undocumented
Class	`_IndexEntry102`	Undocumented
Class	`_IndexEntry200`	Undocumented
Class	`_ROSBagAesCbcEncryptor`	Class for AES-CBC-encrypted bags.
Class	`_ROSBagEncryptor`	Base class for bag encryptor.
Class	`_ROSBagNoEncryptor`	Class for unencrypted bags.
Function	`_add_padding`	Undocumented
Function	`_build_header_from_str`	Undocumented
Function	`_decode_bytes`	Undocumented
Function	`_decode_str`	Undocumented
Function	`_decrypt_string_gpg`	Undocumented
Function	`_encrypt_string_gpg`	Undocumented
Function	`_get_message_type`	Undocumented
Function	`_human_readable_frequency`	Undocumented
Function	`_human_readable_size`	Undocumented
Function	`_median`	Undocumented
Function	`_pack_time`	Undocumented
Function	`_pack_uint32`	Undocumented
Function	`_pack_uint64`	Undocumented
Function	`_pack_uint8`	Undocumented
Function	`_peek_next_header_op`	Undocumented
Function	`_read`	Undocumented
Function	`_read_bytes_field`	Undocumented
Function	`_read_field`	Undocumented
Function	`_read_header`	Undocumented
Function	`_read_record_data`	Undocumented
Function	`_read_sized`	Undocumented
Function	`_read_str_field`	Undocumented
Function	`_read_time`	Undocumented
Function	`_read_time_field`	Undocumented
Function	`_read_uint32`	Undocumented
Function	`_read_uint32_field`	Undocumented
Function	`_read_uint64`	Undocumented
Function	`_read_uint64_field`	Undocumented
Function	`_read_uint8`	Undocumented
Function	`_read_uint8_field`	Undocumented
Function	`_remove_padding`	Undocumented
Function	`_skip_record`	Undocumented
Function	`_skip_sized`	Undocumented
Function	`_time_to_str`	Undocumented
Function	`_unpack_time`	Undocumented
Function	`_unpack_uint32`	Undocumented
Function	`_unpack_uint64`	Undocumented
Function	`_unpack_uint8`	Undocumented
Function	`_write_header`	Undocumented
Function	`_write_record`	Undocumented
Function	`_write_sized`	Undocumented
Constant	`_CHUNK_INDEX_VERSION`	Undocumented
Constant	`_FILE_HEADER_LENGTH`	Undocumented
Constant	`_INDEX_VERSION`	Undocumented
Constant	`_OP_CHUNK`	Undocumented
Constant	`_OP_CHUNK_INFO`	Undocumented
Constant	`_OP_CODES`	Undocumented
Constant	`_OP_CONNECTION`	Undocumented
Constant	`_OP_FILE_HEADER`	Undocumented
Constant	`_OP_INDEX_DATA`	Undocumented
Constant	`_OP_MSG_DATA`	Undocumented
Constant	`_OP_MSG_DEF`	Undocumented
Constant	`_VERSION`	Undocumented
Variable	`_message_types`	Undocumented

BagMessage = ¶

Undocumented

BagMessageWithConnectionHeader = ¶

Undocumented

found_lz4: bool = ¶

Undocumented

def _add_padding(input_bytes): ¶

Undocumented

def _build_header_from_str(header, req_op): ¶

Undocumented

def _decode_bytes(v): ¶

Undocumented

def _decode_str(v): ¶

Undocumented

def _decrypt_string_gpg(input, passphrase=None): ¶

Undocumented

def _encrypt_string_gpg(key_user, input): ¶

Undocumented

def _get_message_type(info): ¶

Undocumented

def _human_readable_frequency(freq): ¶

Undocumented

def _human_readable_size(size): ¶

Undocumented

def _median(values): ¶

Undocumented

def _pack_time(v): ¶

Undocumented

def _pack_uint32(v): ¶

Undocumented

def _pack_uint64(v): ¶

Undocumented

def _pack_uint8(v): ¶

Undocumented

def _peek_next_header_op(f): ¶

Undocumented

def _read(f, size): ¶

Undocumented

def _read_bytes_field(header, field): ¶

Undocumented

def _read_field(header, field, unpack_fn): ¶

Undocumented

def _read_header(f, req_op=None): ¶

Undocumented

def _read_record_data(f): ¶

Undocumented

def _read_sized(f): ¶

Undocumented

def _read_str_field(header, field): ¶

Undocumented

def _read_time(f): ¶

Undocumented

def _read_time_field(header, field): ¶

Undocumented

def _read_uint32(f): ¶

Undocumented

def _read_uint32_field(header, field): ¶

Undocumented

def _read_uint64(f): ¶

Undocumented

def _read_uint64_field(header, field): ¶

Undocumented

def _read_uint8(f): ¶

Undocumented

def _read_uint8_field(header, field): ¶

Undocumented

def _remove_padding(input_str): ¶

Undocumented

def _skip_record(f): ¶

Undocumented

def _skip_sized(f): ¶

Undocumented

def _time_to_str(secs): ¶

Undocumented

def _unpack_time(v): ¶

Undocumented

def _unpack_uint32(v): ¶

Undocumented

def _unpack_uint64(v): ¶

Undocumented

def _unpack_uint8(v): ¶

Undocumented

def _write_header(f, header): ¶

Undocumented

def _write_record(f, header, data='', padded_size=None): ¶

Undocumented

def _write_sized(f, v): ¶

Undocumented

_CHUNK_INDEX_VERSION: int = ¶

Undocumented

Value

_FILE_HEADER_LENGTH: int = ¶

Undocumented

Value

_INDEX_VERSION: int = ¶

Undocumented

Value

_OP_CHUNK: int = ¶

Undocumented

Value

_OP_CHUNK_INFO: int = ¶

Undocumented

Value

_OP_CODES = ¶

Undocumented

Value

{_OP_MSG_DEF: 'MSG_DEF',
 _OP_MSG_DATA: 'MSG_DATA',
 _OP_FILE_HEADER: 'FILE_HEADER',
 _OP_INDEX_DATA: 'INDEX_DATA',
 _OP_CHUNK: 'CHUNK',
 _OP_CHUNK_INFO: 'CHUNK_INFO',
 _OP_CONNECTION: 'CONNECTION'}

_OP_CONNECTION: int = ¶

Undocumented

Value

_OP_FILE_HEADER: int = ¶

Undocumented

Value

_OP_INDEX_DATA: int = ¶

Undocumented

Value

_OP_MSG_DATA: int = ¶

Undocumented

Value

_OP_MSG_DEF: int = ¶

Undocumented

Value

_VERSION: str = ¶

Undocumented

Value

'#ROSBAG V2.0'

_message_types: dict = ¶

Undocumented