YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::rosmsg::diagnostic_msgs::DiagnosticStatus Class Reference

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

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

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::diagnostic_msgs::DiagnosticStatusrosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::diagnostic_msgs::DiagnosticStatusbottleStyle
 

Public Member Functions

 DiagnosticStatus ()
 
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.
 
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.
 
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.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor.
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

std::uint8_t level
 
std::string name
 
std::string message
 
std::string hardware_id
 
std::vector< yarp::rosmsg::diagnostic_msgs::KeyValuevalues
 

Static Public Attributes

static const std::uint8_t OK = 0
 
static const std::uint8_t WARN = 1
 
static const std::uint8_t ERROR = 2
 
static const std::uint8_t STALE = 3
 
static constexpr const char * typeName = "diagnostic_msgs/DiagnosticStatus"
 
static constexpr const char * typeChecksum = "d0ce08bc6e5ba34c7754f563a9cabaf1"
 
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.
 

Detailed Description

Definition at line 41 of file DiagnosticStatus.h.

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ DiagnosticStatus()

yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::DiagnosticStatus ( )
inline

Definition at line 54 of file DiagnosticStatus.h.

Member Function Documentation

◆ clear()

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

Definition at line 63 of file DiagnosticStatus.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 282 of file DiagnosticStatus.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 89 of file DiagnosticStatus.h.

◆ readBottle()

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

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

Definition at line 127 of file DiagnosticStatus.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 175 of file DiagnosticStatus.h.

◆ writeBottle()

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

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

Definition at line 203 of file DiagnosticStatus.h.

Member Data Documentation

◆ ERROR

const std::uint8_t yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::ERROR = 2
static

Definition at line 46 of file DiagnosticStatus.h.

◆ hardware_id

std::string yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::hardware_id

Definition at line 51 of file DiagnosticStatus.h.

◆ level

std::uint8_t yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::level

Definition at line 48 of file DiagnosticStatus.h.

◆ message

std::string yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::message

Definition at line 50 of file DiagnosticStatus.h.

◆ name

std::string yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::name

Definition at line 49 of file DiagnosticStatus.h.

◆ OK

const std::uint8_t yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::OK = 0
static

Definition at line 44 of file DiagnosticStatus.h.

◆ STALE

const std::uint8_t yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::STALE = 3
static

Definition at line 47 of file DiagnosticStatus.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::typeChecksum = "d0ce08bc6e5ba34c7754f563a9cabaf1"
staticconstexpr

Definition at line 256 of file DiagnosticStatus.h.

◆ typeName

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

Definition at line 253 of file DiagnosticStatus.h.

◆ typeText

constexpr const char* yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::typeText
staticconstexpr
Initial value:
= "\
# This message holds the status of an individual component of the robot.\n\
# \n\
\n\
# Possible levels of operations\n\
byte OK=0\n\
byte WARN=1\n\
byte ERROR=2\n\
byte STALE=3\n\
\n\
byte level # level of operation enumerated above \n\
string name # a description of the test/component reporting\n\
string message # a description of the status\n\
string hardware_id # a hardware unique string\n\
KeyValue[] values # an array of values associated with the status\n\
\n\
\n\
================================================================================\n\
MSG: diagnostic_msgs/KeyValue\n\
string key # what to label this value when viewing\n\
string value # a value to track over time\n\
"

Definition at line 259 of file DiagnosticStatus.h.

◆ values

std::vector<yarp::rosmsg::diagnostic_msgs::KeyValue> yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::values

Definition at line 52 of file DiagnosticStatus.h.

◆ WARN

const std::uint8_t yarp::rosmsg::diagnostic_msgs::DiagnosticStatus::WARN = 1
static

Definition at line 45 of file DiagnosticStatus.h.


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