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

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

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

Public Types

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

Public Member Functions

 ImageMarker ()
 
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
 
std::string ns
 
std::int32_t id
 
std::int32_t type
 
std::int32_t action
 
yarp::rosmsg::geometry_msgs::Point position
 
yarp::conf::float32_t scale
 
yarp::rosmsg::std_msgs::ColorRGBA outline_color
 
std::uint8_t filled
 
yarp::rosmsg::std_msgs::ColorRGBA fill_color
 
yarp::rosmsg::TickDuration lifetime
 
std::vector< yarp::rosmsg::geometry_msgs::Point > points
 
std::vector< yarp::rosmsg::std_msgs::ColorRGBA > outline_colors
 

Static Public Attributes

static const std::uint8_t CIRCLE = 0
 
static const std::uint8_t LINE_STRIP = 1
 
static const std::uint8_t LINE_LIST = 2
 
static const std::uint8_t POLYGON = 3
 
static const std::uint8_t POINTS = 4
 
static const std::uint8_t ADD = 0
 
static const std::uint8_t REMOVE = 1
 
static constexpr const char * typeName = "visualization_msgs/ImageMarker"
 
static constexpr const char * typeChecksum = "1de93c67ec8858b831025a08fbf1b35c"
 
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 ImageMarker.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 461 of file ImageMarker.h.

◆ rosStyle

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

Definition at line 460 of file ImageMarker.h.

Constructor & Destructor Documentation

◆ ImageMarker()

yarp::rosmsg::visualization_msgs::ImageMarker::ImageMarker ( )
inline

Definition at line 79 of file ImageMarker.h.

Member Function Documentation

◆ clear()

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

Definition at line 96 of file ImageMarker.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 528 of file ImageMarker.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 152 of file ImageMarker.h.

◆ readBottle()

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

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

Definition at line 222 of file ImageMarker.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 309 of file ImageMarker.h.

◆ writeBottle()

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

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

Definition at line 374 of file ImageMarker.h.

Member Data Documentation

◆ action

std::int32_t yarp::rosmsg::visualization_msgs::ImageMarker::action

Definition at line 69 of file ImageMarker.h.

◆ ADD

const std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::ADD = 0
static

Definition at line 63 of file ImageMarker.h.

◆ CIRCLE

const std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::CIRCLE = 0
static

Definition at line 58 of file ImageMarker.h.

◆ fill_color

yarp::rosmsg::std_msgs::ColorRGBA yarp::rosmsg::visualization_msgs::ImageMarker::fill_color

Definition at line 74 of file ImageMarker.h.

◆ filled

std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::filled

Definition at line 73 of file ImageMarker.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::visualization_msgs::ImageMarker::header

Definition at line 65 of file ImageMarker.h.

◆ id

std::int32_t yarp::rosmsg::visualization_msgs::ImageMarker::id

Definition at line 67 of file ImageMarker.h.

◆ lifetime

yarp::rosmsg::TickDuration yarp::rosmsg::visualization_msgs::ImageMarker::lifetime

Definition at line 75 of file ImageMarker.h.

◆ LINE_LIST

const std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::LINE_LIST = 2
static

Definition at line 60 of file ImageMarker.h.

◆ LINE_STRIP

const std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::LINE_STRIP = 1
static

Definition at line 59 of file ImageMarker.h.

◆ ns

std::string yarp::rosmsg::visualization_msgs::ImageMarker::ns

Definition at line 66 of file ImageMarker.h.

◆ outline_color

yarp::rosmsg::std_msgs::ColorRGBA yarp::rosmsg::visualization_msgs::ImageMarker::outline_color

Definition at line 72 of file ImageMarker.h.

◆ outline_colors

std::vector<yarp::rosmsg::std_msgs::ColorRGBA> yarp::rosmsg::visualization_msgs::ImageMarker::outline_colors

Definition at line 77 of file ImageMarker.h.

◆ POINTS

const std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::POINTS = 4
static

Definition at line 62 of file ImageMarker.h.

◆ points

std::vector<yarp::rosmsg::geometry_msgs::Point> yarp::rosmsg::visualization_msgs::ImageMarker::points

Definition at line 76 of file ImageMarker.h.

◆ POLYGON

const std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::POLYGON = 3
static

Definition at line 61 of file ImageMarker.h.

◆ position

yarp::rosmsg::geometry_msgs::Point yarp::rosmsg::visualization_msgs::ImageMarker::position

Definition at line 70 of file ImageMarker.h.

◆ REMOVE

const std::uint8_t yarp::rosmsg::visualization_msgs::ImageMarker::REMOVE = 1
static

Definition at line 64 of file ImageMarker.h.

◆ scale

yarp::conf::float32_t yarp::rosmsg::visualization_msgs::ImageMarker::scale

Definition at line 71 of file ImageMarker.h.

◆ type

std::int32_t yarp::rosmsg::visualization_msgs::ImageMarker::type

Definition at line 68 of file ImageMarker.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::visualization_msgs::ImageMarker::typeChecksum = "1de93c67ec8858b831025a08fbf1b35c"
staticconstexpr

Definition at line 467 of file ImageMarker.h.

◆ typeName

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

Definition at line 464 of file ImageMarker.h.

◆ typeText

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

Definition at line 470 of file ImageMarker.h.

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