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

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

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

Public Types

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

Public Member Functions

 Plane ()
 
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::vector< yarp::conf::float64_t > coef
 

Static Public Attributes

static constexpr const char * typeName = "shape_msgs/Plane"
 
static constexpr const char * typeChecksum = "2c1b92ed8f31492f8e73f6a4a44ca796"
 
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 36 of file Plane.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 130 of file Plane.h.

◆ rosStyle

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

Definition at line 129 of file Plane.h.

Constructor & Destructor Documentation

◆ Plane()

yarp::rosmsg::shape_msgs::Plane::Plane ( )
inline

Definition at line 41 of file Plane.h.

Member Function Documentation

◆ clear()

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

Definition at line 47 of file Plane.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 150 of file Plane.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 54 of file Plane.h.

◆ readBottle()

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

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

Definition at line 66 of file Plane.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 94 of file Plane.h.

◆ writeBottle()

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

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

Definition at line 104 of file Plane.h.

Member Data Documentation

◆ coef

std::vector<yarp::conf::float64_t> yarp::rosmsg::shape_msgs::Plane::coef

Definition at line 39 of file Plane.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::shape_msgs::Plane::typeChecksum = "2c1b92ed8f31492f8e73f6a4a44ca796"
staticconstexpr

Definition at line 136 of file Plane.h.

◆ typeName

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

Definition at line 133 of file Plane.h.

◆ typeText

constexpr const char* yarp::rosmsg::shape_msgs::Plane::typeText
staticconstexpr
Initial value:
= "\
# Representation of a plane, using the plane equation ax + by + cz + d = 0\n\
\n\
# a := coef[0]\n\
# b := coef[1]\n\
# c := coef[2]\n\
# d := coef[3]\n\
\n\
float64[4] coef\n\
"

Definition at line 139 of file Plane.h.

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