Gazebo Transport

API Reference

11.4.1
Message Class Reference

Represents a message in a bag file. More...

#include <Message.hh>

Public Member Functions

 Message ()
 Default constructor. More...
 
 Message (const Message &_other)=delete
 No copy constructor to prevent borrowed pointers from living beyond creator's expectations. More...
 
 Message (const std::chrono::nanoseconds &_timeRecv, const void *_data, std::size_t _dataLen, const char *_type, std::size_t _typeLen, const char *_topic, std::size_t _topicLen)
 Construct with data. More...
 
 Message (Message &&_other)=delete
 No move constructor to prevent borrowed pointers from living beyond creator's expectations. More...
 
 ~Message ()
 Destructor. More...
 
std::string Data () const
 Get the message data. More...
 
const std::chrono::nanosecondsTimeReceived () const
 Return the time the message was received. More...
 
std::string Topic () const
 Get the Topic name as a string. More...
 
std::string Type () const
 Get the message type as a string. More...
 

Detailed Description

Represents a message in a bag file.

Constructor & Destructor Documentation

◆ Message() [1/4]

Message ( )

Default constructor.

◆ Message() [2/4]

Message ( const std::chrono::nanoseconds _timeRecv,
const void *  _data,
std::size_t  _dataLen,
const char *  _type,
std::size_t  _typeLen,
const char *  _topic,
std::size_t  _topicLen 
)

Construct with data.

◆ Message() [3/4]

Message ( Message &&  _other)
delete

No move constructor to prevent borrowed pointers from living beyond creator's expectations.

◆ Message() [4/4]

Message ( const Message _other)
delete

No copy constructor to prevent borrowed pointers from living beyond creator's expectations.

◆ ~Message()

~Message ( )

Destructor.

Member Function Documentation

◆ Data()

std::string Data ( ) const

Get the message data.

Returns
The raw data for this message

◆ TimeReceived()

const std::chrono::nanoseconds& TimeReceived ( ) const

Return the time the message was received.

Returns
The time the message was received

◆ Topic()

std::string Topic ( ) const

Get the Topic name as a string.

Returns
The topic for the message

◆ Type()

std::string Type ( ) const

Get the message type as a string.

Returns
The message type name

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