yarp::rosmsg::diagnostic_msgs::AddDiagnostics Class Reference

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

Inheritance diagram for yarp::rosmsg::diagnostic_msgs::AddDiagnostics:

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

Public Member Functions
	AddDiagnostics ()
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	load_namespace

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

Member Typedef Documentation

bottleStyle

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

Definition at line 139 of file AddDiagnostics.h.

rosStyle

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

Definition at line 138 of file AddDiagnostics.h.

Constructor & Destructor Documentation

AddDiagnostics()

yarp::rosmsg::diagnostic_msgs::AddDiagnostics::AddDiagnostics ( )

inline

Definition at line 60 of file AddDiagnostics.h.

Member Function Documentation

clear()

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

inline

Definition at line 65 of file AddDiagnostics.h.

getType()

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

inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 178 of file AddDiagnostics.h.

read()

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

readBare()

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

inlineoverridevirtual

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

Definition at line 71 of file AddDiagnostics.h.

readBottle()

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

inlineoverridevirtual

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

Definition at line 83 of file AddDiagnostics.h.

write()

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

writeBare()

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

inlineoverridevirtual

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

Definition at line 106 of file AddDiagnostics.h.

writeBottle()

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

inlineoverridevirtual

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

Definition at line 115 of file AddDiagnostics.h.

Member Data Documentation

load_namespace

std::string yarp::rosmsg::diagnostic_msgs::AddDiagnostics::load_namespace

Definition at line 58 of file AddDiagnostics.h.

typeChecksum

constexpr const char* yarp::rosmsg::diagnostic_msgs::AddDiagnostics::typeChecksum = "c26cf6e164288fbc6050d74f838bcdf0"

staticconstexpr

Definition at line 145 of file AddDiagnostics.h.

typeName

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

staticconstexpr

Definition at line 142 of file AddDiagnostics.h.

typeText

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

staticconstexpr

Initial value:

= "\
# This service is used as part of the process for loading analyzers at runtime,\n\
# and should be used by a loader script or program, not as a standalone service.\n\
# Information about dynamic addition of analyzers can be found at\n\
# http://wiki.ros.org/diagnostics/Tutorials/Adding%20Analyzers%20at%20Runtime\n\
\n\
# The load_namespace parameter defines the namespace where parameters for the\n\
# initialization of analyzers in the diagnostic aggregator have been loaded. The\n\
# value should be a global name (i.e. /my/name/space), not a relative\n\
# (my/name/space) or private (~my/name/space) name. Analyzers will not be added\n\
# if a non-global name is used. The call will also fail if the namespace\n\
# contains parameters that follow a namespace structure that does not conform to\n\
# that expected by the analyzer definitions. See\n\
# http://wiki.ros.org/diagnostics/Tutorials/Configuring%20Diagnostic%20Aggregators\n\
# and http://wiki.ros.org/diagnostics/Tutorials/Using%20the%20GenericAnalyzer\n\
# for examples of the structure of yaml files which are expected to have been\n\
# loaded into the namespace.\n\
string load_namespace\n\
---\n\
\n\
# True if diagnostic aggregator was updated with new diagnostics, False\n\
# otherwise. A false return value means that either there is a bond in the\n\
# aggregator which already used the requested namespace, or the initialization\n\
# of analyzers failed.\n\
bool success\n\
\n\
# Message with additional information about the success or failure\n\
string message\n\
"

Definition at line 148 of file AddDiagnostics.h.

---

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

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