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

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

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

Public Types

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

Public Member Functions

 InteractiveMarkerControl ()
 
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 name
 
yarp::rosmsg::geometry_msgs::Quaternion orientation
 
std::uint8_t orientation_mode
 
std::uint8_t interaction_mode
 
bool always_visible
 
std::vector< yarp::rosmsg::visualization_msgs::Marker > markers
 
bool independent_marker_orientation
 
std::string description
 

Static Public Attributes

static const std::uint8_t INHERIT = 0
 
static const std::uint8_t FIXED = 1
 
static const std::uint8_t VIEW_FACING = 2
 
static const std::uint8_t NONE = 0
 
static const std::uint8_t MENU = 1
 
static const std::uint8_t BUTTON = 2
 
static const std::uint8_t MOVE_AXIS = 3
 
static const std::uint8_t MOVE_PLANE = 4
 
static const std::uint8_t ROTATE_AXIS = 5
 
static const std::uint8_t MOVE_ROTATE = 6
 
static const std::uint8_t MOVE_3D = 7
 
static const std::uint8_t ROTATE_3D = 8
 
static const std::uint8_t MOVE_ROTATE_3D = 9
 
static constexpr const char * typeName = "visualization_msgs/InteractiveMarkerControl"
 
static constexpr const char * typeChecksum = "b3c81e785788195d1840b86c28da1aac"
 
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 107 of file InteractiveMarkerControl.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 400 of file InteractiveMarkerControl.h.

◆ rosStyle

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

Definition at line 399 of file InteractiveMarkerControl.h.

Constructor & Destructor Documentation

◆ InteractiveMarkerControl()

yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::InteractiveMarkerControl ( )
inline

Definition at line 132 of file InteractiveMarkerControl.h.

Member Function Documentation

◆ clear()

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

Definition at line 144 of file InteractiveMarkerControl.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 595 of file InteractiveMarkerControl.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 197 of file InteractiveMarkerControl.h.

◆ readBottle()

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

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

Definition at line 246 of file InteractiveMarkerControl.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 303 of file InteractiveMarkerControl.h.

◆ writeBottle()

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

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

Definition at line 341 of file InteractiveMarkerControl.h.

Member Data Documentation

◆ always_visible

bool yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::always_visible

Definition at line 127 of file InteractiveMarkerControl.h.

◆ BUTTON

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::BUTTON = 2
static

Definition at line 118 of file InteractiveMarkerControl.h.

◆ description

std::string yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::description

Definition at line 130 of file InteractiveMarkerControl.h.

◆ FIXED

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::FIXED = 1
static

Definition at line 113 of file InteractiveMarkerControl.h.

◆ independent_marker_orientation

bool yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::independent_marker_orientation

Definition at line 129 of file InteractiveMarkerControl.h.

◆ INHERIT

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::INHERIT = 0
static

Definition at line 112 of file InteractiveMarkerControl.h.

◆ interaction_mode

std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::interaction_mode

Definition at line 126 of file InteractiveMarkerControl.h.

◆ markers

std::vector<yarp::rosmsg::visualization_msgs::Marker> yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::markers

Definition at line 128 of file InteractiveMarkerControl.h.

◆ MENU

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::MENU = 1
static

Definition at line 117 of file InteractiveMarkerControl.h.

◆ MOVE_3D

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::MOVE_3D = 7
static

Definition at line 123 of file InteractiveMarkerControl.h.

◆ MOVE_AXIS

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::MOVE_AXIS = 3
static

Definition at line 119 of file InteractiveMarkerControl.h.

◆ MOVE_PLANE

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::MOVE_PLANE = 4
static

Definition at line 120 of file InteractiveMarkerControl.h.

◆ MOVE_ROTATE

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::MOVE_ROTATE = 6
static

Definition at line 122 of file InteractiveMarkerControl.h.

◆ MOVE_ROTATE_3D

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::MOVE_ROTATE_3D = 9
static

Definition at line 125 of file InteractiveMarkerControl.h.

◆ name

std::string yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::name

Definition at line 110 of file InteractiveMarkerControl.h.

◆ NONE

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::NONE = 0
static

Definition at line 116 of file InteractiveMarkerControl.h.

◆ orientation

yarp::rosmsg::geometry_msgs::Quaternion yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::orientation

Definition at line 111 of file InteractiveMarkerControl.h.

◆ orientation_mode

std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::orientation_mode

Definition at line 115 of file InteractiveMarkerControl.h.

◆ ROTATE_3D

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::ROTATE_3D = 8
static

Definition at line 124 of file InteractiveMarkerControl.h.

◆ ROTATE_AXIS

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::ROTATE_AXIS = 5
static

Definition at line 121 of file InteractiveMarkerControl.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::typeChecksum = "b3c81e785788195d1840b86c28da1aac"
staticconstexpr

Definition at line 406 of file InteractiveMarkerControl.h.

◆ typeName

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

Definition at line 403 of file InteractiveMarkerControl.h.

◆ typeText

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

Definition at line 409 of file InteractiveMarkerControl.h.

◆ VIEW_FACING

const std::uint8_t yarp::rosmsg::visualization_msgs::InteractiveMarkerControl::VIEW_FACING = 2
static

Definition at line 114 of file InteractiveMarkerControl.h.

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