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

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

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

Public Types

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

Public Member Functions

 Marker ()
 
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::Pose pose
 
yarp::rosmsg::geometry_msgs::Vector3 scale
 
yarp::rosmsg::std_msgs::ColorRGBA color
 
yarp::rosmsg::TickDuration lifetime
 
bool frame_locked
 
std::vector< yarp::rosmsg::geometry_msgs::Point > points
 
std::vector< yarp::rosmsg::std_msgs::ColorRGBA > colors
 
std::string text
 
std::string mesh_resource
 
bool mesh_use_embedded_materials
 

Static Public Attributes

static const std::uint8_t ARROW = 0
 
static const std::uint8_t CUBE = 1
 
static const std::uint8_t SPHERE = 2
 
static const std::uint8_t CYLINDER = 3
 
static const std::uint8_t LINE_STRIP = 4
 
static const std::uint8_t LINE_LIST = 5
 
static const std::uint8_t CUBE_LIST = 6
 
static const std::uint8_t SPHERE_LIST = 7
 
static const std::uint8_t POINTS = 8
 
static const std::uint8_t TEXT_VIEW_FACING = 9
 
static const std::uint8_t MESH_RESOURCE = 10
 
static const std::uint8_t TRIANGLE_LIST = 11
 
static const std::uint8_t ADD = 0
 
static const std::uint8_t MODIFY = 0
 
static const std::uint8_t DELETE = 2
 
static const std::uint8_t DELETEALL = 3
 
static constexpr const char * typeName = "visualization_msgs/Marker"
 
static constexpr const char * typeChecksum = "4048c9de2a16f4ae8e0538085ebf1b97"
 
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 78 of file Marker.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 567 of file Marker.h.

◆ rosStyle

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

Definition at line 566 of file Marker.h.

Constructor & Destructor Documentation

◆ Marker()

yarp::rosmsg::visualization_msgs::Marker::Marker ( )
inline

Definition at line 113 of file Marker.h.

Member Function Documentation

◆ clear()

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

Definition at line 132 of file Marker.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 682 of file Marker.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 212 of file Marker.h.

◆ readBottle()

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

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

Definition at line 300 of file Marker.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 397 of file Marker.h.

◆ writeBottle()

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

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

Definition at line 470 of file Marker.h.

Member Data Documentation

◆ action

std::int32_t yarp::rosmsg::visualization_msgs::Marker::action

Definition at line 101 of file Marker.h.

◆ ADD

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

Definition at line 93 of file Marker.h.

◆ ARROW

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::ARROW = 0
static

Definition at line 81 of file Marker.h.

◆ color

yarp::rosmsg::std_msgs::ColorRGBA yarp::rosmsg::visualization_msgs::Marker::color

Definition at line 104 of file Marker.h.

◆ colors

std::vector<yarp::rosmsg::std_msgs::ColorRGBA> yarp::rosmsg::visualization_msgs::Marker::colors

Definition at line 108 of file Marker.h.

◆ CUBE

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::CUBE = 1
static

Definition at line 82 of file Marker.h.

◆ CUBE_LIST

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::CUBE_LIST = 6
static

Definition at line 87 of file Marker.h.

◆ CYLINDER

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::CYLINDER = 3
static

Definition at line 84 of file Marker.h.

◆ DELETE

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::DELETE = 2
static

Definition at line 95 of file Marker.h.

◆ DELETEALL

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::DELETEALL = 3
static

Definition at line 96 of file Marker.h.

◆ frame_locked

bool yarp::rosmsg::visualization_msgs::Marker::frame_locked

Definition at line 106 of file Marker.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::visualization_msgs::Marker::header

Definition at line 97 of file Marker.h.

◆ id

std::int32_t yarp::rosmsg::visualization_msgs::Marker::id

Definition at line 99 of file Marker.h.

◆ lifetime

yarp::rosmsg::TickDuration yarp::rosmsg::visualization_msgs::Marker::lifetime

Definition at line 105 of file Marker.h.

◆ LINE_LIST

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::LINE_LIST = 5
static

Definition at line 86 of file Marker.h.

◆ LINE_STRIP

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::LINE_STRIP = 4
static

Definition at line 85 of file Marker.h.

◆ MESH_RESOURCE

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::MESH_RESOURCE = 10
static

Definition at line 91 of file Marker.h.

◆ mesh_resource

std::string yarp::rosmsg::visualization_msgs::Marker::mesh_resource

Definition at line 110 of file Marker.h.

◆ mesh_use_embedded_materials

bool yarp::rosmsg::visualization_msgs::Marker::mesh_use_embedded_materials

Definition at line 111 of file Marker.h.

◆ MODIFY

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::MODIFY = 0
static

Definition at line 94 of file Marker.h.

◆ ns

std::string yarp::rosmsg::visualization_msgs::Marker::ns

Definition at line 98 of file Marker.h.

◆ POINTS

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::POINTS = 8
static

Definition at line 89 of file Marker.h.

◆ points

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

Definition at line 107 of file Marker.h.

◆ pose

yarp::rosmsg::geometry_msgs::Pose yarp::rosmsg::visualization_msgs::Marker::pose

Definition at line 102 of file Marker.h.

◆ scale

yarp::rosmsg::geometry_msgs::Vector3 yarp::rosmsg::visualization_msgs::Marker::scale

Definition at line 103 of file Marker.h.

◆ SPHERE

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::SPHERE = 2
static

Definition at line 83 of file Marker.h.

◆ SPHERE_LIST

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::SPHERE_LIST = 7
static

Definition at line 88 of file Marker.h.

◆ text

std::string yarp::rosmsg::visualization_msgs::Marker::text

Definition at line 109 of file Marker.h.

◆ TEXT_VIEW_FACING

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::TEXT_VIEW_FACING = 9
static

Definition at line 90 of file Marker.h.

◆ TRIANGLE_LIST

const std::uint8_t yarp::rosmsg::visualization_msgs::Marker::TRIANGLE_LIST = 11
static

Definition at line 92 of file Marker.h.

◆ type

std::int32_t yarp::rosmsg::visualization_msgs::Marker::type

Definition at line 100 of file Marker.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::visualization_msgs::Marker::typeChecksum = "4048c9de2a16f4ae8e0538085ebf1b97"
staticconstexpr

Definition at line 573 of file Marker.h.

◆ typeName

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

Definition at line 570 of file Marker.h.

◆ typeText

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

Definition at line 576 of file Marker.h.

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