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

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

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

Public Types

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

Public Member Functions

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

yarp::rosmsg::std_msgs::Header header
 
yarp::rosmsg::geometry_msgs::Pose pose
 
std::string name
 
std::string description
 
yarp::conf::float32_t scale
 
std::vector< yarp::rosmsg::visualization_msgs::MenuEntry > menu_entries
 
std::vector< yarp::rosmsg::visualization_msgs::InteractiveMarkerControl > controls
 

Static Public Attributes

static constexpr const char * typeName = "visualization_msgs/InteractiveMarker"
 
static constexpr const char * typeChecksum = "dd86d22909d5a3364b384492e35c10af"
 
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 58 of file InteractiveMarker.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 322 of file InteractiveMarker.h.

◆ rosStyle

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

Definition at line 321 of file InteractiveMarker.h.

Constructor & Destructor Documentation

◆ InteractiveMarker()

yarp::rosmsg::visualization_msgs::InteractiveMarker::InteractiveMarker ( )
inline

Definition at line 69 of file InteractiveMarker.h.

Member Function Documentation

◆ clear()

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

Definition at line 80 of file InteractiveMarker.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 603 of file InteractiveMarker.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 104 of file InteractiveMarker.h.

◆ readBottle()

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

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

Definition at line 154 of file InteractiveMarker.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 219 of file InteractiveMarker.h.

◆ writeBottle()

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

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

Definition at line 261 of file InteractiveMarker.h.

Member Data Documentation

◆ controls

std::vector<yarp::rosmsg::visualization_msgs::InteractiveMarkerControl> yarp::rosmsg::visualization_msgs::InteractiveMarker::controls

Definition at line 67 of file InteractiveMarker.h.

◆ description

std::string yarp::rosmsg::visualization_msgs::InteractiveMarker::description

Definition at line 64 of file InteractiveMarker.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::visualization_msgs::InteractiveMarker::header

Definition at line 61 of file InteractiveMarker.h.

◆ menu_entries

std::vector<yarp::rosmsg::visualization_msgs::MenuEntry> yarp::rosmsg::visualization_msgs::InteractiveMarker::menu_entries

Definition at line 66 of file InteractiveMarker.h.

◆ name

std::string yarp::rosmsg::visualization_msgs::InteractiveMarker::name

Definition at line 63 of file InteractiveMarker.h.

◆ pose

yarp::rosmsg::geometry_msgs::Pose yarp::rosmsg::visualization_msgs::InteractiveMarker::pose

Definition at line 62 of file InteractiveMarker.h.

◆ scale

yarp::conf::float32_t yarp::rosmsg::visualization_msgs::InteractiveMarker::scale

Definition at line 65 of file InteractiveMarker.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::visualization_msgs::InteractiveMarker::typeChecksum = "dd86d22909d5a3364b384492e35c10af"
staticconstexpr

Definition at line 328 of file InteractiveMarker.h.

◆ typeName

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

Definition at line 325 of file InteractiveMarker.h.

◆ typeText

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

Definition at line 331 of file InteractiveMarker.h.

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