YARP
Yet Another Robot Platform
yarp::rosmsg::sensor_msgs::Image Class Reference

#include <yarp/rosmsg/sensor_msgs/Image.h>

+ Inheritance diagram for yarp::rosmsg::sensor_msgs::Image:

Detailed Description

Definition at line 56 of file Image.h.

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::sensor_msgs::ImagerosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::sensor_msgs::ImagebottleStyle
 

Public Member Functions

 Image ()
 
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...
 
std::string getTypeText () const
 
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
 

Static Public Member Functions

static std::string typeText ()
 
- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading. More...
 

Public Attributes

yarp::rosmsg::std_msgs::Header header
 
std::uint32_t height
 
std::uint32_t width
 
std::string encoding
 
std::uint8_t is_bigendian
 
std::uint32_t step
 
std::vector< std::uint8_t > data
 

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ Image()

yarp::rosmsg::sensor_msgs::Image::Image ( )
inline

Definition at line 67 of file Image.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::sensor_msgs::Image::clear ( )
inline

Definition at line 78 of file Image.h.

◆ getType()

yarp::os::Type yarp::rosmsg::sensor_msgs::Image::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 317 of file Image.h.

◆ getTypeText()

std::string yarp::rosmsg::sensor_msgs::Image::getTypeText ( ) const
inline

Definition at line 311 of file Image.h.

◆ read()

bool yarp::rosmsg::sensor_msgs::Image::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 182 of file Image.h.

◆ readBare()

bool yarp::rosmsg::sensor_msgs::Image::readBare ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 102 of file Image.h.

◆ readBottle()

bool yarp::rosmsg::sensor_msgs::Image::readBottle ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 138 of file Image.h.

◆ typeText()

static std::string yarp::rosmsg::sensor_msgs::Image::typeText ( )
inlinestatic

Definition at line 275 of file Image.h.

◆ write()

bool yarp::rosmsg::sensor_msgs::Image::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 263 of file Image.h.

◆ writeBare()

bool yarp::rosmsg::sensor_msgs::Image::writeBare ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 188 of file Image.h.

◆ writeBottle()

bool yarp::rosmsg::sensor_msgs::Image::writeBottle ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 220 of file Image.h.

Member Data Documentation

◆ data

std::vector<std::uint8_t> yarp::rosmsg::sensor_msgs::Image::data

Definition at line 65 of file Image.h.

◆ encoding

std::string yarp::rosmsg::sensor_msgs::Image::encoding

Definition at line 62 of file Image.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::sensor_msgs::Image::header

Definition at line 59 of file Image.h.

◆ height

std::uint32_t yarp::rosmsg::sensor_msgs::Image::height

Definition at line 60 of file Image.h.

◆ is_bigendian

std::uint8_t yarp::rosmsg::sensor_msgs::Image::is_bigendian

Definition at line 63 of file Image.h.

◆ step

std::uint32_t yarp::rosmsg::sensor_msgs::Image::step

Definition at line 64 of file Image.h.

◆ width

std::uint32_t yarp::rosmsg::sensor_msgs::Image::width

Definition at line 61 of file Image.h.


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