Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

return_connection_header is not documented #1811

Open
christian-rauch opened this issue Sep 23, 2019 · 1 comment
Open

return_connection_header is not documented #1811

christian-rauch opened this issue Sep 23, 2019 · 1 comment

Comments

@christian-rauch
Copy link
Contributor

The function of parameter return_connection_header for python method read_messages

def read_messages(self, topics=None, start_time=None, end_time=None, connection_filter=None, raw=False, return_connection_header=False):
"""
Read messages from the bag, optionally filtered by topic, timestamp and connection details.
@param topics: list of topics or a single topic. if an empty list is given all topics will be read [optional]
@type topics: list(str) or str
@param start_time: earliest timestamp of message to return [optional]
@type start_time: U{genpy.Time}
@param end_time: latest timestamp of message to return [optional]
@type end_time: U{genpy.Time}
@param connection_filter: function to filter connections to include [optional]
@type connection_filter: function taking (topic, datatype, md5sum, msg_def, header) and returning bool
@param raw: if True, then generate tuples of (datatype, (data, md5sum, position), pytype)
@type raw: bool
@return: generator of BagMessage(topic, message, timestamp) namedtuples for each message in the bag file
@rtype: generator of tuples of (str, U{genpy.Message}, U{genpy.Time}) [not raw] or (str, (str, str, str, tuple, class), U{genpy.Time}) [raw]
"""

is not documented.

@dirk-thomas
Copy link
Member

@ddimarco Since you introduced this argument in #1372 can you please contribute the missing documentation for it. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants