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

#include <yarp/rosmsg/diagnostic_msgs/SelfTest.h>

+ Inheritance diagram for yarp::rosmsg::diagnostic_msgs::SelfTest:

Public Types

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

Public Member Functions

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

Static Public Attributes

static constexpr const char * typeName = "diagnostic_msgs/SelfTest"
 
static constexpr const char * typeChecksum = "d41d8cd98f00b204e9800998ecf8427e"
 
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 29 of file SelfTest.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::diagnostic_msgs::SelfTest> yarp::rosmsg::diagnostic_msgs::SelfTest::bottleStyle

Definition at line 92 of file SelfTest.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::diagnostic_msgs::SelfTest> yarp::rosmsg::diagnostic_msgs::SelfTest::rosStyle

Definition at line 91 of file SelfTest.h.

Constructor & Destructor Documentation

◆ SelfTest()

yarp::rosmsg::diagnostic_msgs::SelfTest::SelfTest ( )
inline

Definition at line 33 of file SelfTest.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::diagnostic_msgs::SelfTest::clear ( )
inline

Definition at line 37 of file SelfTest.h.

◆ getType()

yarp::os::Type yarp::rosmsg::diagnostic_msgs::SelfTest::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 108 of file SelfTest.h.

◆ read()

bool yarp::rosmsg::diagnostic_msgs::SelfTest::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 60 of file SelfTest.h.

◆ readBare()

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

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

Definition at line 41 of file SelfTest.h.

◆ readBottle()

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

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

Definition at line 47 of file SelfTest.h.

◆ write()

bool yarp::rosmsg::diagnostic_msgs::SelfTest::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 83 of file SelfTest.h.

◆ writeBare()

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

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

Definition at line 66 of file SelfTest.h.

◆ writeBottle()

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

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

Definition at line 72 of file SelfTest.h.

Member Data Documentation

◆ typeChecksum

constexpr const char* yarp::rosmsg::diagnostic_msgs::SelfTest::typeChecksum = "d41d8cd98f00b204e9800998ecf8427e"
staticconstexpr

Definition at line 98 of file SelfTest.h.

◆ typeName

constexpr const char* yarp::rosmsg::diagnostic_msgs::SelfTest::typeName = "diagnostic_msgs/SelfTest"
staticconstexpr

Definition at line 95 of file SelfTest.h.

◆ typeText

constexpr const char* yarp::rosmsg::diagnostic_msgs::SelfTest::typeText
staticconstexpr
Initial value:
= "\
---\n\
string id\n\
byte passed\n\
DiagnosticStatus[] status\n\
"

Definition at line 101 of file SelfTest.h.

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