Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
rosbag::MessageInstance Class Reference

A class pointing into a bag file. More...

#include <message_instance.h>

Public Member Functions

std::string getCallerId () const
 
boost::shared_ptr< ros::M_stringgetConnectionHeader () const
 
std::string const & getDataType () const
 
std::string const & getMD5Sum () const
 
std::string const & getMessageDefinition () const
 
ros::Time const & getTime () const
 
std::string const & getTopic () const
 
template<class T >
boost::shared_ptr< T > instantiate () const
 Templated call to instantiate a message. More...
 
bool isLatching () const
 
template<class T >
bool isType () const
 Test whether the underlying message of the specified type. More...
 
uint32_t size () const
 Size of serialized message. More...
 
template<typename Stream >
void write (Stream &stream) const
 Write serialized message contents out to a stream. More...
 

Private Member Functions

 MessageInstance (ConnectionInfo const *connection_info, IndexEntry const &index, Bag const &bag)
 

Private Attributes

Bag const * bag_
 
ConnectionInfo const * connection_info_
 
IndexEntry const index_entry_
 

Friends

class View
 

Detailed Description

A class pointing into a bag file.

The MessageInstance class itself is fairly light weight. It simply contains a pointer to a bag-file and the index_entry necessary to get access to the corresponding data.

It adheres to the necessary ros::message_traits to be directly serializable.

Definition at line 59 of file message_instance.h.

Constructor & Destructor Documentation

◆ MessageInstance()

rosbag::MessageInstance::MessageInstance ( ConnectionInfo const *  connection_info,
IndexEntry const &  index,
Bag const &  bag 
)
private

Definition at line 38 of file message_instance.cpp.

Member Function Documentation

◆ getCallerId()

string rosbag::MessageInstance::getCallerId ( ) const

Definition at line 51 of file message_instance.cpp.

◆ getConnectionHeader()

shared_ptr< ros::M_string > rosbag::MessageInstance::getConnectionHeader ( ) const

Definition at line 49 of file message_instance.cpp.

◆ getDataType()

string const & rosbag::MessageInstance::getDataType ( ) const

Definition at line 45 of file message_instance.cpp.

◆ getMD5Sum()

string const & rosbag::MessageInstance::getMD5Sum ( ) const

Definition at line 46 of file message_instance.cpp.

◆ getMessageDefinition()

string const & rosbag::MessageInstance::getMessageDefinition ( ) const

Definition at line 47 of file message_instance.cpp.

◆ getTime()

Time const & rosbag::MessageInstance::getTime ( ) const

Definition at line 43 of file message_instance.cpp.

◆ getTopic()

string const & rosbag::MessageInstance::getTopic ( ) const

Definition at line 44 of file message_instance.cpp.

◆ instantiate()

template<class T >
boost::shared_ptr< T > rosbag::MessageInstance::instantiate ( ) const

Templated call to instantiate a message.

returns NULL pointer if incompatible

Definition at line 161 of file message_instance.h.

◆ isLatching()

bool rosbag::MessageInstance::isLatching ( ) const

Definition at line 56 of file message_instance.cpp.

◆ isType()

template<class T >
bool rosbag::MessageInstance::isType ( ) const

Test whether the underlying message of the specified type.

returns true iff the message is of the template type

Definition at line 155 of file message_instance.h.

◆ size()

uint32_t rosbag::MessageInstance::size ( ) const

Size of serialized message.

Definition at line 61 of file message_instance.cpp.

◆ write()

template<typename Stream >
void rosbag::MessageInstance::write ( Stream stream) const

Write serialized message contents out to a stream.

Definition at line 169 of file message_instance.h.

Friends And Related Function Documentation

◆ View

friend class View
friend

Definition at line 61 of file message_instance.h.

Member Data Documentation

◆ bag_

Bag const* rosbag::MessageInstance::bag_
private

Definition at line 101 of file message_instance.h.

◆ connection_info_

ConnectionInfo const* rosbag::MessageInstance::connection_info_
private

Definition at line 99 of file message_instance.h.

◆ index_entry_

IndexEntry const rosbag::MessageInstance::index_entry_
private

Definition at line 100 of file message_instance.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