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

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

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

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::sensor_msgs::RegionOfInterest > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::sensor_msgs::RegionOfInterest > bottleStyle
 

Public Member Functions

 RegionOfInterest ()
 
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::uint32_t x_offset
 
std::uint32_t y_offset
 
std::uint32_t height
 
std::uint32_t width
 
bool do_rectify
 

Static Public Attributes

static constexpr const char * typeName = "sensor_msgs/RegionOfInterest"
 
static constexpr const char * typeChecksum = "bdb633039d588fcccb441a4d43ccfe09"
 
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 47 of file RegionOfInterest.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::sensor_msgs::RegionOfInterest> yarp::rosmsg::sensor_msgs::RegionOfInterest::bottleStyle

Definition at line 197 of file RegionOfInterest.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::sensor_msgs::RegionOfInterest> yarp::rosmsg::sensor_msgs::RegionOfInterest::rosStyle

Definition at line 196 of file RegionOfInterest.h.

Constructor & Destructor Documentation

◆ RegionOfInterest()

yarp::rosmsg::sensor_msgs::RegionOfInterest::RegionOfInterest ( )
inline

Definition at line 56 of file RegionOfInterest.h.

Member Function Documentation

◆ clear()

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

Definition at line 65 of file RegionOfInterest.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 228 of file RegionOfInterest.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 83 of file RegionOfInterest.h.

◆ readBottle()

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

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

Definition at line 105 of file RegionOfInterest.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 138 of file RegionOfInterest.h.

◆ writeBottle()

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

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

Definition at line 158 of file RegionOfInterest.h.

Member Data Documentation

◆ do_rectify

bool yarp::rosmsg::sensor_msgs::RegionOfInterest::do_rectify

Definition at line 54 of file RegionOfInterest.h.

◆ height

std::uint32_t yarp::rosmsg::sensor_msgs::RegionOfInterest::height

Definition at line 52 of file RegionOfInterest.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::sensor_msgs::RegionOfInterest::typeChecksum = "bdb633039d588fcccb441a4d43ccfe09"
staticconstexpr

Definition at line 203 of file RegionOfInterest.h.

◆ typeName

constexpr const char* yarp::rosmsg::sensor_msgs::RegionOfInterest::typeName = "sensor_msgs/RegionOfInterest"
staticconstexpr

Definition at line 200 of file RegionOfInterest.h.

◆ typeText

constexpr const char* yarp::rosmsg::sensor_msgs::RegionOfInterest::typeText
staticconstexpr
Initial value:
= "\
# This message is used to specify a region of interest within an image.\n\
#\n\
# When used to specify the ROI setting of the camera when the image was\n\
# taken, the height and width fields should either match the height and\n\
# width fields for the associated image; or height = width = 0\n\
# indicates that the full resolution image was captured.\n\
\n\
uint32 x_offset # Leftmost pixel of the ROI\n\
# (0 if the ROI includes the left edge of the image)\n\
uint32 y_offset # Topmost pixel of the ROI\n\
# (0 if the ROI includes the top edge of the image)\n\
uint32 height # Height of ROI\n\
uint32 width # Width of ROI\n\
\n\
# True if a distinct rectified ROI should be calculated from the \"raw\"\n\
# ROI in this message. Typically this should be False if the full image\n\
# is captured (ROI not used), and True if a subwindow is captured (ROI\n\
# used).\n\
bool do_rectify\n\
"

Definition at line 206 of file RegionOfInterest.h.

◆ width

std::uint32_t yarp::rosmsg::sensor_msgs::RegionOfInterest::width

Definition at line 53 of file RegionOfInterest.h.

◆ x_offset

std::uint32_t yarp::rosmsg::sensor_msgs::RegionOfInterest::x_offset

Definition at line 50 of file RegionOfInterest.h.

◆ y_offset

std::uint32_t yarp::rosmsg::sensor_msgs::RegionOfInterest::y_offset

Definition at line 51 of file RegionOfInterest.h.

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