yarp::rosmsg::diagnostic_msgs::KeyValue Class Reference

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

Inheritance diagram for yarp::rosmsg::diagnostic_msgs::KeyValue:

Public Types
typedef yarp::os::idl::BareStyle< yarp::rosmsg::diagnostic_msgs::KeyValue >	rosStyle
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::diagnostic_msgs::KeyValue >	bottleStyle

Public Member Functions
	KeyValue ()
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::string	key
std::string	value

Static Public Attributes
static constexpr const char *	typeName = "diagnostic_msgs/KeyValue"
static constexpr const char *	typeChecksum = "cf57fdc6617a881a88c16e768132149c"
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 30 of file KeyValue.h.

Member Typedef Documentation

bottleStyle

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

Definition at line 140 of file KeyValue.h.

rosStyle

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

Definition at line 139 of file KeyValue.h.

Constructor & Destructor Documentation

KeyValue()

yarp::rosmsg::diagnostic_msgs::KeyValue::KeyValue ( )

inline

Definition at line 36 of file KeyValue.h.

Member Function Documentation

clear()

void yarp::rosmsg::diagnostic_msgs::KeyValue::clear ( )

inline

Definition at line 42 of file KeyValue.h.

getType()

yarp::os::Type yarp::rosmsg::diagnostic_msgs::KeyValue::getType ( ) const

inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 154 of file KeyValue.h.

read()

bool yarp::rosmsg::diagnostic_msgs::KeyValue::read ( yarp::os::ConnectionReader &  reader )

inlineoverridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 92 of file KeyValue.h.

readBare()

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

inlineoverridevirtual

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

Definition at line 51 of file KeyValue.h.

readBottle()

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

inlineoverridevirtual

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

Definition at line 70 of file KeyValue.h.

write()

bool yarp::rosmsg::diagnostic_msgs::KeyValue::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

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 131 of file KeyValue.h.

writeBare()

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

inlineoverridevirtual

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

Definition at line 98 of file KeyValue.h.

writeBottle()

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

inlineoverridevirtual

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

Definition at line 111 of file KeyValue.h.

Member Data Documentation

key

std::string yarp::rosmsg::diagnostic_msgs::KeyValue::key

Definition at line 33 of file KeyValue.h.

typeChecksum

constexpr const char* yarp::rosmsg::diagnostic_msgs::KeyValue::typeChecksum = "cf57fdc6617a881a88c16e768132149c"

staticconstexpr

Definition at line 146 of file KeyValue.h.

typeName

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

staticconstexpr

Definition at line 143 of file KeyValue.h.

typeText

constexpr const char* yarp::rosmsg::diagnostic_msgs::KeyValue::typeText

staticconstexpr

Initial value:

= "\
string key # what to label this value when viewing\n\
string value # a value to track over time\n\
"

Definition at line 149 of file KeyValue.h.

value

std::string yarp::rosmsg::diagnostic_msgs::KeyValue::value

Definition at line 34 of file KeyValue.h.

---

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

• src/libYARP_rosmsg/src/idl_generated_code/yarp/rosmsg/diagnostic_msgs/KeyValue.h