YARP
Yet Another Robot Platform
yarp::rosmsg::sensor_msgs::TimeReference Class Reference

#include <yarp/rosmsg/sensor_msgs/TimeReference.h>

+ Inheritance diagram for yarp::rosmsg::sensor_msgs::TimeReference:

Detailed Description

Definition at line 37 of file TimeReference.h.

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::sensor_msgs::TimeReferencerosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::sensor_msgs::TimeReferencebottleStyle
 

Public Member Functions

 TimeReference ()
 
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

yarp::rosmsg::std_msgs::Header header
 
yarp::rosmsg::TickTime time_ref
 
std::string source
 

Static Public Attributes

static constexpr const char * typeName = "sensor_msgs/TimeReference"
 
static constexpr const char * typeChecksum = "fded64a0265108ba86c3d38fb11c0c16"
 
static constexpr const char * typeText
 

Additional Inherited Members

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

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ TimeReference()

yarp::rosmsg::sensor_msgs::TimeReference::TimeReference ( )
inline

Definition at line 44 of file TimeReference.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::sensor_msgs::TimeReference::clear ( )
inline

Definition at line 51 of file TimeReference.h.

◆ getType()

yarp::os::Type yarp::rosmsg::sensor_msgs::TimeReference::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 208 of file TimeReference.h.

◆ read()

bool yarp::rosmsg::sensor_msgs::TimeReference::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 112 of file TimeReference.h.

◆ readBare()

bool yarp::rosmsg::sensor_msgs::TimeReference::readBare ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 63 of file TimeReference.h.

◆ readBottle()

bool yarp::rosmsg::sensor_msgs::TimeReference::readBottle ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 85 of file TimeReference.h.

◆ write()

bool yarp::rosmsg::sensor_msgs::TimeReference::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 TimeReference.h.

◆ writeBare()

bool yarp::rosmsg::sensor_msgs::TimeReference::writeBare ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 118 of file TimeReference.h.

◆ writeBottle()

bool yarp::rosmsg::sensor_msgs::TimeReference::writeBottle ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 137 of file TimeReference.h.

Member Data Documentation

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::sensor_msgs::TimeReference::header

Definition at line 40 of file TimeReference.h.

◆ source

std::string yarp::rosmsg::sensor_msgs::TimeReference::source

Definition at line 42 of file TimeReference.h.

◆ time_ref

yarp::rosmsg::TickTime yarp::rosmsg::sensor_msgs::TimeReference::time_ref

Definition at line 41 of file TimeReference.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::sensor_msgs::TimeReference::typeChecksum = "fded64a0265108ba86c3d38fb11c0c16"
static

Definition at line 177 of file TimeReference.h.

◆ typeName

constexpr const char* yarp::rosmsg::sensor_msgs::TimeReference::typeName = "sensor_msgs/TimeReference"
static

Definition at line 174 of file TimeReference.h.

◆ typeText

constexpr const char* yarp::rosmsg::sensor_msgs::TimeReference::typeText
static
Initial value:
= "\
# Measurement from an external time source not actively synchronized with the system clock.\n\
\n\
Header header # stamp is system time for which measurement was valid\n\
# frame_id is not used \n\
\n\
time time_ref # corresponding time from this external source\n\
string source # (optional) name of time source\n\
\n\
================================================================================\n\
MSG: std_msgs/Header\n\
# 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 TimeReference.h.


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