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

#include <yarp/rosmsg/shape_msgs/SolidPrimitive.h>

+ Inheritance diagram for yarp::rosmsg::shape_msgs::SolidPrimitive:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::shape_msgs::SolidPrimitive > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::shape_msgs::SolidPrimitive > bottleStyle
 

Public Member Functions

 SolidPrimitive ()
 
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::uint8_t type
 
std::vector< yarp::conf::float64_t > dimensions
 

Static Public Attributes

static const std::uint8_t BOX = 1
 
static const std::uint8_t SPHERE = 2
 
static const std::uint8_t CYLINDER = 3
 
static const std::uint8_t CONE = 4
 
static const std::uint8_t BOX_X = 0
 
static const std::uint8_t BOX_Y = 1
 
static const std::uint8_t BOX_Z = 2
 
static const std::uint8_t SPHERE_RADIUS = 0
 
static const std::uint8_t CYLINDER_HEIGHT = 0
 
static const std::uint8_t CYLINDER_RADIUS = 1
 
static const std::uint8_t CONE_HEIGHT = 0
 
static const std::uint8_t CONE_RADIUS = 1
 
static constexpr const char * typeName = "shape_msgs/SolidPrimitive"
 
static constexpr const char * typeChecksum = "d8f8cbc74c5ff283fca29569ccefb45d"
 
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 70 of file SolidPrimitive.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::shape_msgs::SolidPrimitive> yarp::rosmsg::shape_msgs::SolidPrimitive::bottleStyle

Definition at line 217 of file SolidPrimitive.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::shape_msgs::SolidPrimitive> yarp::rosmsg::shape_msgs::SolidPrimitive::rosStyle

Definition at line 216 of file SolidPrimitive.h.

Constructor & Destructor Documentation

◆ SolidPrimitive()

yarp::rosmsg::shape_msgs::SolidPrimitive::SolidPrimitive ( )
inline

Definition at line 88 of file SolidPrimitive.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::shape_msgs::SolidPrimitive::clear ( )
inline

Definition at line 94 of file SolidPrimitive.h.

◆ getType()

yarp::os::Type yarp::rosmsg::shape_msgs::SolidPrimitive::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 271 of file SolidPrimitive.h.

◆ read()

bool yarp::rosmsg::shape_msgs::SolidPrimitive::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 167 of file SolidPrimitive.h.

◆ readBare()

bool yarp::rosmsg::shape_msgs::SolidPrimitive::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 127 of file SolidPrimitive.h.

◆ readBottle()

bool yarp::rosmsg::shape_msgs::SolidPrimitive::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 142 of file SolidPrimitive.h.

◆ write()

bool yarp::rosmsg::shape_msgs::SolidPrimitive::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 208 of file SolidPrimitive.h.

◆ writeBare()

bool yarp::rosmsg::shape_msgs::SolidPrimitive::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 173 of file SolidPrimitive.h.

◆ writeBottle()

bool yarp::rosmsg::shape_msgs::SolidPrimitive::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 187 of file SolidPrimitive.h.

Member Data Documentation

◆ BOX

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::BOX = 1
static

Definition at line 73 of file SolidPrimitive.h.

◆ BOX_X

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::BOX_X = 0
static

Definition at line 79 of file SolidPrimitive.h.

◆ BOX_Y

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::BOX_Y = 1
static

Definition at line 80 of file SolidPrimitive.h.

◆ BOX_Z

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::BOX_Z = 2
static

Definition at line 81 of file SolidPrimitive.h.

◆ CONE

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::CONE = 4
static

Definition at line 76 of file SolidPrimitive.h.

◆ CONE_HEIGHT

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::CONE_HEIGHT = 0
static

Definition at line 85 of file SolidPrimitive.h.

◆ CONE_RADIUS

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::CONE_RADIUS = 1
static

Definition at line 86 of file SolidPrimitive.h.

◆ CYLINDER

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::CYLINDER = 3
static

Definition at line 75 of file SolidPrimitive.h.

◆ CYLINDER_HEIGHT

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::CYLINDER_HEIGHT = 0
static

Definition at line 83 of file SolidPrimitive.h.

◆ CYLINDER_RADIUS

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::CYLINDER_RADIUS = 1
static

Definition at line 84 of file SolidPrimitive.h.

◆ dimensions

std::vector<yarp::conf::float64_t> yarp::rosmsg::shape_msgs::SolidPrimitive::dimensions

Definition at line 78 of file SolidPrimitive.h.

◆ SPHERE

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::SPHERE = 2
static

Definition at line 74 of file SolidPrimitive.h.

◆ SPHERE_RADIUS

const std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::SPHERE_RADIUS = 0
static

Definition at line 82 of file SolidPrimitive.h.

◆ type

std::uint8_t yarp::rosmsg::shape_msgs::SolidPrimitive::type

Definition at line 77 of file SolidPrimitive.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::shape_msgs::SolidPrimitive::typeChecksum = "d8f8cbc74c5ff283fca29569ccefb45d"
staticconstexpr

Definition at line 223 of file SolidPrimitive.h.

◆ typeName

constexpr const char* yarp::rosmsg::shape_msgs::SolidPrimitive::typeName = "shape_msgs/SolidPrimitive"
staticconstexpr

Definition at line 220 of file SolidPrimitive.h.

◆ typeText

constexpr const char* yarp::rosmsg::shape_msgs::SolidPrimitive::typeText
staticconstexpr

Definition at line 226 of file SolidPrimitive.h.

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