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

#include <yarp/rosmsg/visualization_msgs/MenuEntry.h>

+ Inheritance diagram for yarp::rosmsg::visualization_msgs::MenuEntry:

Public Types

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

Public Member Functions

 MenuEntry ()
 
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 id
 
std::uint32_t parent_id
 
std::string title
 
std::string command
 
std::uint8_t command_type
 

Static Public Attributes

static const std::uint8_t FEEDBACK = 0
 
static const std::uint8_t ROSRUN = 1
 
static const std::uint8_t ROSLAUNCH = 2
 
static constexpr const char * typeName = "visualization_msgs/MenuEntry"
 
static constexpr const char * typeChecksum = "b90ec63024573de83b57aa93eb39be2d"
 
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 79 of file MenuEntry.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::visualization_msgs::MenuEntry> yarp::rosmsg::visualization_msgs::MenuEntry::bottleStyle

Definition at line 252 of file MenuEntry.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::visualization_msgs::MenuEntry> yarp::rosmsg::visualization_msgs::MenuEntry::rosStyle

Definition at line 251 of file MenuEntry.h.

Constructor & Destructor Documentation

◆ MenuEntry()

yarp::rosmsg::visualization_msgs::MenuEntry::MenuEntry ( )
inline

Definition at line 91 of file MenuEntry.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::visualization_msgs::MenuEntry::clear ( )
inline

Definition at line 100 of file MenuEntry.h.

◆ getType()

yarp::os::Type yarp::rosmsg::visualization_msgs::MenuEntry::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 318 of file MenuEntry.h.

◆ read()

bool yarp::rosmsg::visualization_msgs::MenuEntry::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 183 of file MenuEntry.h.

◆ readBare()

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

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

Definition at line 124 of file MenuEntry.h.

◆ readBottle()

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

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

Definition at line 152 of file MenuEntry.h.

◆ write()

bool yarp::rosmsg::visualization_msgs::MenuEntry::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 243 of file MenuEntry.h.

◆ writeBare()

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

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

Definition at line 189 of file MenuEntry.h.

◆ writeBottle()

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

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

Definition at line 211 of file MenuEntry.h.

Member Data Documentation

◆ command

std::string yarp::rosmsg::visualization_msgs::MenuEntry::command

Definition at line 85 of file MenuEntry.h.

◆ command_type

std::uint8_t yarp::rosmsg::visualization_msgs::MenuEntry::command_type

Definition at line 89 of file MenuEntry.h.

◆ FEEDBACK

const std::uint8_t yarp::rosmsg::visualization_msgs::MenuEntry::FEEDBACK = 0
static

Definition at line 86 of file MenuEntry.h.

◆ id

std::uint32_t yarp::rosmsg::visualization_msgs::MenuEntry::id

Definition at line 82 of file MenuEntry.h.

◆ parent_id

std::uint32_t yarp::rosmsg::visualization_msgs::MenuEntry::parent_id

Definition at line 83 of file MenuEntry.h.

◆ ROSLAUNCH

const std::uint8_t yarp::rosmsg::visualization_msgs::MenuEntry::ROSLAUNCH = 2
static

Definition at line 88 of file MenuEntry.h.

◆ ROSRUN

const std::uint8_t yarp::rosmsg::visualization_msgs::MenuEntry::ROSRUN = 1
static

Definition at line 87 of file MenuEntry.h.

◆ title

std::string yarp::rosmsg::visualization_msgs::MenuEntry::title

Definition at line 84 of file MenuEntry.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::visualization_msgs::MenuEntry::typeChecksum = "b90ec63024573de83b57aa93eb39be2d"
staticconstexpr

Definition at line 258 of file MenuEntry.h.

◆ typeName

constexpr const char* yarp::rosmsg::visualization_msgs::MenuEntry::typeName = "visualization_msgs/MenuEntry"
staticconstexpr

Definition at line 255 of file MenuEntry.h.

◆ typeText

constexpr const char* yarp::rosmsg::visualization_msgs::MenuEntry::typeText
staticconstexpr

Definition at line 261 of file MenuEntry.h.

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