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

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

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

Public Types

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

Public Member Functions

 InteractiveMarkerUpdate ()
 
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 server_id
 
std::uint64_t seq_num
 
std::uint8_t type
 
std::vector< yarp::rosmsg::visualization_msgs::InteractiveMarker > markers
 
std::vector< yarp::rosmsg::visualization_msgs::InteractiveMarkerPose > poses
 
std::vector< std::string > erases
 

Static Public Attributes

static const std::uint8_t KEEP_ALIVE = 0
 
static const std::uint8_t UPDATE = 1
 
static constexpr const char * typeName = "visualization_msgs/InteractiveMarkerUpdate"
 
static constexpr const char * typeChecksum = "710d308d0a9276d65945e92dd30b3946"
 
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 61 of file InteractiveMarkerUpdate.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 318 of file InteractiveMarkerUpdate.h.

◆ rosStyle

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

Definition at line 317 of file InteractiveMarkerUpdate.h.

Constructor & Destructor Documentation

◆ InteractiveMarkerUpdate()

yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::InteractiveMarkerUpdate ( )
inline

Definition at line 73 of file InteractiveMarkerUpdate.h.

Member Function Documentation

◆ clear()

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

Definition at line 83 of file InteractiveMarkerUpdate.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 645 of file InteractiveMarkerUpdate.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 108 of file InteractiveMarkerUpdate.h.

◆ readBottle()

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

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

Definition at line 155 of file InteractiveMarkerUpdate.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 222 of file InteractiveMarkerUpdate.h.

◆ writeBottle()

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

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

Definition at line 260 of file InteractiveMarkerUpdate.h.

Member Data Documentation

◆ erases

std::vector<std::string> yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::erases

Definition at line 71 of file InteractiveMarkerUpdate.h.

◆ KEEP_ALIVE

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::KEEP_ALIVE = 0
static

Definition at line 66 of file InteractiveMarkerUpdate.h.

◆ markers

std::vector<yarp::rosmsg::visualization_msgs::InteractiveMarker> yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::markers

Definition at line 69 of file InteractiveMarkerUpdate.h.

◆ poses

std::vector<yarp::rosmsg::visualization_msgs::InteractiveMarkerPose> yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::poses

Definition at line 70 of file InteractiveMarkerUpdate.h.

◆ seq_num

std::uint64_t yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::seq_num

Definition at line 65 of file InteractiveMarkerUpdate.h.

◆ server_id

std::string yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::server_id

Definition at line 64 of file InteractiveMarkerUpdate.h.

◆ type

std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::type

Definition at line 68 of file InteractiveMarkerUpdate.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::typeChecksum = "710d308d0a9276d65945e92dd30b3946"
staticconstexpr

Definition at line 324 of file InteractiveMarkerUpdate.h.

◆ typeName

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

Definition at line 321 of file InteractiveMarkerUpdate.h.

◆ typeText

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

Definition at line 327 of file InteractiveMarkerUpdate.h.

◆ UPDATE

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerUpdate::UPDATE = 1
static

Definition at line 67 of file InteractiveMarkerUpdate.h.

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