Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
rosbag::View Class Reference

#include <view.h>

Classes

class  iterator
 An iterator that points to a MessageInstance from a bag. More...
 
struct  TrueQuery
 

Public Types

typedef iterator const_iterator
 

Public Member Functions

void addQuery (Bag const &bag, ros::Time const &start_time=ros::TIME_MIN, ros::Time const &end_time=ros::TIME_MAX)
 Add a query to a view. More...
 
void addQuery (Bag const &bag, boost::function< bool(ConnectionInfo const *)> query, ros::Time const &start_time=ros::TIME_MIN, ros::Time const &end_time=ros::TIME_MAX)
 Add a query to a view. More...
 
iterator begin ()
 Simply copy the merge_queue state into the iterator. More...
 
iterator end ()
 Default constructed iterator signifies end. More...
 
ros::Time getBeginTime ()
 
std::vector< const ConnectionInfo * > getConnections ()
 
ros::Time getEndTime ()
 
uint32_t size ()
 
 View (bool const &reduce_overlap=false)
 Create a view on a bag. More...
 
 View (Bag const &bag, ros::Time const &start_time=ros::TIME_MIN, ros::Time const &end_time=ros::TIME_MAX, bool const &reduce_overlap=false)
 Create a view on a bag. More...
 
 View (Bag const &bag, boost::function< bool(ConnectionInfo const *)> query, ros::Time const &start_time=ros::TIME_MIN, ros::Time const &end_time=ros::TIME_MAX, bool const &reduce_overlap=false)
 Create a view and add a query. More...
 
 ~View ()
 

Protected Member Functions

MessageInstancenewMessageInstance (ConnectionInfo const *connection_info, IndexEntry const &index, Bag const &bag)
 
void update ()
 
void updateQueries (BagQuery *q)
 

Protected Attributes

std::vector< BagQuery * > queries_
 
std::vector< MessageRange * > ranges_
 
bool reduce_overlap_
 
uint32_t size_cache_
 
uint32_t size_revision_
 
uint32_t view_revision_
 

Private Member Functions

Viewoperator= (View const &view)
 
 View (View const &view)
 

Friends

class Bag
 
class iterator
 

Detailed Description

Definition at line 48 of file view.h.

Member Typedef Documentation

◆ const_iterator

Definition at line 93 of file view.h.

Constructor & Destructor Documentation

◆ View() [1/4]

rosbag::View::View ( bool const &  reduce_overlap = false)

Create a view on a bag.

param reduce_overlap If multiple views return the same messages, reduce them to a single message

Definition at line 166 of file view.cpp.

◆ View() [2/4]

rosbag::View::View ( Bag const &  bag,
ros::Time const &  start_time = ros::TIME_MIN,
ros::Time const &  end_time = ros::TIME_MAX,
bool const &  reduce_overlap = false 
)

Create a view on a bag.

param bag The bag file on which to run this query param start_time The beginning of the time range for the query param end_time The end of the time range for the query param reduce_overlap If multiple views return the same messages, reduce them to a single message

Definition at line 168 of file view.cpp.

◆ View() [3/4]

rosbag::View::View ( Bag const &  bag,
boost::function< bool(ConnectionInfo const *)>  query,
ros::Time const &  start_time = ros::TIME_MIN,
ros::Time const &  end_time = ros::TIME_MAX,
bool const &  reduce_overlap = false 
)

Create a view and add a query.

param bag The bag file on which to run this query param query The actual query to evaluate which connections to include param start_time The beginning of the time range for the query param end_time The end of the time range for the query param reduce_overlap If multiple views return the same messages, reduce them to a single message

Definition at line 172 of file view.cpp.

◆ ~View()

rosbag::View::~View ( )

Definition at line 176 of file view.cpp.

◆ View() [4/4]

rosbag::View::View ( View const &  view)
private

Member Function Documentation

◆ addQuery() [1/2]

void rosbag::View::addQuery ( Bag const &  bag,
ros::Time const &  start_time = ros::TIME_MIN,
ros::Time const &  end_time = ros::TIME_MAX 
)

Add a query to a view.

param bag The bag file on which to run this query param start_time The beginning of the time range for the query param end_time The end of the time range for the query

Definition at line 245 of file view.cpp.

◆ addQuery() [2/2]

void rosbag::View::addQuery ( Bag const &  bag,
boost::function< bool(ConnectionInfo const *)>  query,
ros::Time const &  start_time = ros::TIME_MIN,
ros::Time const &  end_time = ros::TIME_MAX 
)

Add a query to a view.

param bag The bag file on which to run this query param query The actual query to evaluate which connections to include param start_time The beginning of the time range for the query param end_time The end of the time range for the query

Definition at line 256 of file view.cpp.

◆ begin()

View::iterator rosbag::View::begin ( )

Simply copy the merge_queue state into the iterator.

Definition at line 218 of file view.cpp.

◆ end()

View::iterator rosbag::View::end ( )

Default constructed iterator signifies end.

Definition at line 224 of file view.cpp.

◆ getBeginTime()

ros::Time rosbag::View::getBeginTime ( )

Definition at line 184 of file view.cpp.

◆ getConnections()

std::vector< const ConnectionInfo * > rosbag::View::getConnections ( )

Definition at line 329 of file view.cpp.

◆ getEndTime()

ros::Time rosbag::View::getEndTime ( )

Definition at line 199 of file view.cpp.

◆ newMessageInstance()

MessageInstance * rosbag::View::newMessageInstance ( ConnectionInfo const *  connection_info,
IndexEntry const &  index,
Bag const &  bag 
)
protected

Definition at line 342 of file view.cpp.

◆ operator=()

View& rosbag::View::operator= ( View const &  view)
private

◆ size()

uint32_t rosbag::View::size ( )

Definition at line 226 of file view.cpp.

◆ update()

void rosbag::View::update ( )
protected

Definition at line 320 of file view.cpp.

◆ updateQueries()

void rosbag::View::updateQueries ( BagQuery q)
protected

Definition at line 265 of file view.cpp.

Friends And Related Function Documentation

◆ Bag

friend class Bag
friend

Definition at line 50 of file view.h.

◆ iterator

friend class iterator
friend

Definition at line 155 of file view.h.

Member Data Documentation

◆ queries_

std::vector<BagQuery*> rosbag::View::queries_
protected

Definition at line 168 of file view.h.

◆ ranges_

std::vector<MessageRange*> rosbag::View::ranges_
protected

Definition at line 167 of file view.h.

◆ reduce_overlap_

bool rosbag::View::reduce_overlap_
protected

Definition at line 174 of file view.h.

◆ size_cache_

uint32_t rosbag::View::size_cache_
protected

Definition at line 171 of file view.h.

◆ size_revision_

uint32_t rosbag::View::size_revision_
protected

Definition at line 172 of file view.h.

◆ view_revision_

uint32_t rosbag::View::view_revision_
protected

Definition at line 169 of file view.h.


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


rosbag_storage
Author(s): Dirk Thomas
autogenerated on Wed Apr 28 2021 02:23:49