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

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

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

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::sensor_msgs::RangerosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::sensor_msgs::RangebottleStyle
 

Public Member Functions

 Range ()
 
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::uint8_t radiation_type
 
yarp::conf::float32_t field_of_view
 
yarp::conf::float32_t min_range
 
yarp::conf::float32_t max_range
 
yarp::conf::float32_t range
 

Static Public Attributes

static const std::uint8_t ULTRASOUND = 0
 
static const std::uint8_t INFRARED = 1
 
static constexpr const char * typeName = "sensor_msgs/Range"
 
static constexpr const char * typeChecksum = "c005c34273dc426c67a020a87bc24148"
 
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 65 of file Range.h.

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ Range()

yarp::rosmsg::sensor_msgs::Range::Range ( )
inline

Definition at line 77 of file Range.h.

Member Function Documentation

◆ clear()

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

Definition at line 87 of file Range.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 313 of file Range.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 112 of file Range.h.

◆ readBottle()

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

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

Definition at line 137 of file Range.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 175 of file Range.h.

◆ writeBottle()

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

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

Definition at line 200 of file Range.h.

Member Data Documentation

◆ field_of_view

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::Range::field_of_view

Definition at line 72 of file Range.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::sensor_msgs::Range::header

Definition at line 68 of file Range.h.

◆ INFRARED

const std::uint8_t yarp::rosmsg::sensor_msgs::Range::INFRARED = 1
static

Definition at line 70 of file Range.h.

◆ max_range

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::Range::max_range

Definition at line 74 of file Range.h.

◆ min_range

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::Range::min_range

Definition at line 73 of file Range.h.

◆ radiation_type

std::uint8_t yarp::rosmsg::sensor_msgs::Range::radiation_type

Definition at line 71 of file Range.h.

◆ range

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::Range::range

Definition at line 75 of file Range.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::sensor_msgs::Range::typeChecksum = "c005c34273dc426c67a020a87bc24148"
staticconstexpr

Definition at line 250 of file Range.h.

◆ typeName

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

Definition at line 247 of file Range.h.

◆ typeText

constexpr const char* yarp::rosmsg::sensor_msgs::Range::typeText
staticconstexpr

Definition at line 253 of file Range.h.

◆ ULTRASOUND

const std::uint8_t yarp::rosmsg::sensor_msgs::Range::ULTRASOUND = 0
static

Definition at line 69 of file Range.h.


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