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

#include <yarp/rosmsg/TickTime.h>

+ Inheritance diagram for yarp::rosmsg::TickTime:

Public Types

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

Public Member Functions

 TickTime ()
 
 TickTime (double timestamp)
 
TickTime & operator= (const double timestamp)
 
 operator double ()
 
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
 
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. 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 sec
 
std::uint32_t nsec
 

Static Public Attributes

static constexpr const char * typeName = "TickTime"
 
static constexpr const char * typeChecksum = "4771ad66fef816d2e4bead2f45a1cde6"
 
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 26 of file TickTime.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::TickTime> yarp::rosmsg::TickTime::bottleStyle

Definition at line 157 of file TickTime.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::TickTime> yarp::rosmsg::TickTime::rosStyle

Definition at line 156 of file TickTime.h.

Constructor & Destructor Documentation

◆ TickTime() [1/2]

yarp::rosmsg::TickTime::TickTime ( )
inline

Definition at line 32 of file TickTime.h.

◆ TickTime() [2/2]

yarp::rosmsg::TickTime::TickTime ( double  timestamp)
inline

Definition at line 38 of file TickTime.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::TickTime::clear ( )
inline

Definition at line 75 of file TickTime.h.

◆ getType()

yarp::os::Type yarp::rosmsg::TickTime::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 170 of file TickTime.h.

◆ operator double()

yarp::rosmsg::TickTime::operator double ( )
inline

Definition at line 67 of file TickTime.h.

◆ operator=()

TickTime & yarp::rosmsg::TickTime::operator= ( const double  timestamp)
inline

Definition at line 53 of file TickTime.h.

◆ read()

bool yarp::rosmsg::TickTime::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 113 of file TickTime.h.

◆ readBare()

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

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

Definition at line 84 of file TickTime.h.

◆ readBottle()

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

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

Definition at line 95 of file TickTime.h.

◆ write()

bool yarp::rosmsg::TickTime::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 148 of file TickTime.h.

◆ writeBare()

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

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

Definition at line 119 of file TickTime.h.

◆ writeBottle()

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

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

Definition at line 130 of file TickTime.h.

Member Data Documentation

◆ nsec

std::uint32_t yarp::rosmsg::TickTime::nsec

Definition at line 30 of file TickTime.h.

◆ sec

std::uint32_t yarp::rosmsg::TickTime::sec

Definition at line 29 of file TickTime.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::TickTime::typeChecksum = "4771ad66fef816d2e4bead2f45a1cde6"
staticconstexpr

Definition at line 163 of file TickTime.h.

◆ typeName

constexpr const char* yarp::rosmsg::TickTime::typeName = "TickTime"
staticconstexpr

Definition at line 160 of file TickTime.h.

◆ typeText

constexpr const char* yarp::rosmsg::TickTime::typeText
staticconstexpr
Initial value:
= "\
\n\
"

Definition at line 166 of file TickTime.h.

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