YARP
Yet Another Robot Platform
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
yarp::rosmsg::std_msgs::Header Class Reference

#include <yarp/rosmsg/std_msgs/Header.h>

+ Inheritance diagram for yarp::rosmsg::std_msgs::Header:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::std_msgs::Header > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::std_msgs::Header > bottleStyle
 

Public Member Functions

 Header ()
 
void clear ()
 
bool readBare (yarp::os::ConnectionReader &connection) override
 
bool readBottle (yarp::os::ConnectionReader &connection) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool writeBare (yarp::os::ConnectionWriter &connection) const override
 
bool writeBottle (yarp::os::ConnectionWriter &connection) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
yarp::os::Type getType () const override
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool read (yarp::os::idl::WireReader &reader)
 
virtual bool write (const yarp::os::idl::WireWriter &writer) const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

std::uint32_t seq
 
yarp::rosmsg::TickTime stamp
 
std::string frame_id
 

Static Public Attributes

static constexpr const char * typeName = "std_msgs/Header"
 
static constexpr const char * typeChecksum = "2176decaecbce78abc3b96ef049fabed"
 
static constexpr const char * typeText
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading. More...
 

Detailed Description

Definition at line 44 of file Header.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::std_msgs::Header> yarp::rosmsg::std_msgs::Header::bottleStyle

Definition at line 171 of file Header.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::std_msgs::Header> yarp::rosmsg::std_msgs::Header::rosStyle

Definition at line 170 of file Header.h.

Constructor & Destructor Documentation

◆ Header()

yarp::rosmsg::std_msgs::Header::Header ( )
inline

Definition at line 51 of file Header.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::std_msgs::Header::clear ( )
inline

Definition at line 58 of file Header.h.

◆ getType()

yarp::os::Type yarp::rosmsg::std_msgs::Header::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 198 of file Header.h.

◆ read()

bool yarp::rosmsg::std_msgs::Header::read ( yarp::os::ConnectionReader &  reader)
inlineoverridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 115 of file Header.h.

◆ readBare()

bool yarp::rosmsg::std_msgs::Header::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 70 of file Header.h.

◆ readBottle()

bool yarp::rosmsg::std_msgs::Header::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 90 of file Header.h.

◆ write()

bool yarp::rosmsg::std_msgs::Header::write ( yarp::os::ConnectionWriter &  writer) const
inlineoverridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 162 of file Header.h.

◆ writeBare()

bool yarp::rosmsg::std_msgs::Header::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 121 of file Header.h.

◆ writeBottle()

bool yarp::rosmsg::std_msgs::Header::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 138 of file Header.h.

Member Data Documentation

◆ frame_id

std::string yarp::rosmsg::std_msgs::Header::frame_id

Definition at line 49 of file Header.h.

◆ seq

std::uint32_t yarp::rosmsg::std_msgs::Header::seq

Definition at line 47 of file Header.h.

◆ stamp

yarp::rosmsg::TickTime yarp::rosmsg::std_msgs::Header::stamp

Definition at line 48 of file Header.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::std_msgs::Header::typeChecksum = "2176decaecbce78abc3b96ef049fabed"
staticconstexpr

Definition at line 177 of file Header.h.

◆ typeName

constexpr const char* yarp::rosmsg::std_msgs::Header::typeName = "std_msgs/Header"
staticconstexpr

Definition at line 174 of file Header.h.

◆ typeText

constexpr const char* yarp::rosmsg::std_msgs::Header::typeText
staticconstexpr
Initial value:
= "\
# Standard metadata for higher-level stamped data types.\n\
# This is generally used to communicate timestamped data \n\
# in a particular coordinate frame.\n\
# \n\
# sequence ID: consecutively increasing ID \n\
uint32 seq\n\
#Two-integer timestamp that is expressed as:\n\
# * stamp.sec: seconds (stamp_secs) since epoch (in Python the variable is called 'secs')\n\
# * stamp.nsec: nanoseconds since stamp_secs (in Python the variable is called 'nsecs')\n\
# time-handling sugar is provided by the client library\n\
time stamp\n\
#Frame this data is associated with\n\
# 0: no frame\n\
# 1: global frame\n\
string frame_id\n\
"

Definition at line 180 of file Header.h.

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