Public Member Functions | Private Member Functions | Private Attributes | Friends
rosbag::MessageInstance Class Reference

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

#include <message_instance.h>

List of all members.

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.
bool isLatching () const
template<class T >
bool isType () const
 Test whether the underlying message of the specified type.
uint32_t size () const
 Size of serialized message.
template<typename Stream >
void write (Stream &stream) const
 Write serialized message contents out to a stream.

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 57 of file message_instance.h.


Constructor & Destructor Documentation

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

Definition at line 36 of file message_instance.cpp.


Member Function Documentation

Definition at line 49 of file message_instance.cpp.

Definition at line 47 of file message_instance.cpp.

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

Definition at line 43 of file message_instance.cpp.

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

Definition at line 44 of file message_instance.cpp.

Definition at line 45 of file message_instance.cpp.

Definition at line 41 of file message_instance.cpp.

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

Definition at line 42 of file message_instance.cpp.

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 166 of file message_instance.h.

Definition at line 54 of file message_instance.cpp.

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 160 of file message_instance.h.

uint32_t rosbag::MessageInstance::size ( ) const

Size of serialized message.

Definition at line 59 of file message_instance.cpp.

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

Write serialized message contents out to a stream.

Definition at line 174 of file message_instance.h.


Friends And Related Function Documentation

friend class View [friend]

Definition at line 59 of file message_instance.h.


Member Data Documentation

Definition at line 99 of file message_instance.h.

Definition at line 97 of file message_instance.h.

Definition at line 98 of file message_instance.h.


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


rosbag
Author(s): Tim Field (tfield@willowgarage.com), Jeremy Leibs (leibs@willowgarage.com), and James Bowman (jamesb@willowgarage.com)
autogenerated on Sat Dec 28 2013 17:43:05