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

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

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

Public Types

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

Public Member Functions

 LaserScan ()
 
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
 
yarp::conf::float32_t angle_min
 
yarp::conf::float32_t angle_max
 
yarp::conf::float32_t angle_increment
 
yarp::conf::float32_t time_increment
 
yarp::conf::float32_t scan_time
 
yarp::conf::float32_t range_min
 
yarp::conf::float32_t range_max
 
std::vector< yarp::conf::float32_t > ranges
 
std::vector< yarp::conf::float32_t > intensities
 

Static Public Attributes

static constexpr const char * typeName = "sensor_msgs/LaserScan"
 
static constexpr const char * typeChecksum = "90c7ef2dc6895d81024acba2ac42f369"
 
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 58 of file LaserScan.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 337 of file LaserScan.h.

◆ rosStyle

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

Definition at line 336 of file LaserScan.h.

Constructor & Destructor Documentation

◆ LaserScan()

yarp::rosmsg::sensor_msgs::LaserScan::LaserScan ( )
inline

Definition at line 72 of file LaserScan.h.

Member Function Documentation

◆ clear()

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

Definition at line 86 of file LaserScan.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 396 of file LaserScan.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 119 of file LaserScan.h.

◆ readBottle()

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

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

Definition at line 164 of file LaserScan.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 228 of file LaserScan.h.

◆ writeBottle()

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

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

Definition at line 271 of file LaserScan.h.

Member Data Documentation

◆ angle_increment

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::LaserScan::angle_increment

Definition at line 64 of file LaserScan.h.

◆ angle_max

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::LaserScan::angle_max

Definition at line 63 of file LaserScan.h.

◆ angle_min

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::LaserScan::angle_min

Definition at line 62 of file LaserScan.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::sensor_msgs::LaserScan::header

Definition at line 61 of file LaserScan.h.

◆ intensities

std::vector<yarp::conf::float32_t> yarp::rosmsg::sensor_msgs::LaserScan::intensities

Definition at line 70 of file LaserScan.h.

◆ range_max

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::LaserScan::range_max

Definition at line 68 of file LaserScan.h.

◆ range_min

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::LaserScan::range_min

Definition at line 67 of file LaserScan.h.

◆ ranges

std::vector<yarp::conf::float32_t> yarp::rosmsg::sensor_msgs::LaserScan::ranges

Definition at line 69 of file LaserScan.h.

◆ scan_time

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::LaserScan::scan_time

Definition at line 66 of file LaserScan.h.

◆ time_increment

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::LaserScan::time_increment

Definition at line 65 of file LaserScan.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::sensor_msgs::LaserScan::typeChecksum = "90c7ef2dc6895d81024acba2ac42f369"
staticconstexpr

Definition at line 343 of file LaserScan.h.

◆ typeName

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

Definition at line 340 of file LaserScan.h.

◆ typeText

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

Definition at line 346 of file LaserScan.h.

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