YARP
Yet Another Robot Platform
Public Types | Public Member Functions | Public Attributes | List of all members
yarp::dev::LaserScan2D Class Reference

#include <yarp/dev/LaserScan2D.h>

+ Inheritance diagram for yarp::dev::LaserScan2D:

Public Types

typedef yarp::os::idl::Unwrapped< LaserScan2D > unwrapped
 

Public Member Functions

 LaserScan2D ()=default
 
 LaserScan2D (const double angle_min, const double angle_max, const double range_min, const double range_max, const yarp::sig::Vector &scans, const std::int32_t status)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
std::string toString () const
 
- 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
 
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- Public Member Functions inherited from yarp::os::Portable
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. 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

double angle_min {0.0}
 first angle of the scan [deg] More...
 
double angle_max {0.0}
 last angle of the scan [deg] More...
 
double range_min {0.0}
 the minimum distance of the scan [m] More...
 
double range_max {0.0}
 the maximum distance of the scan [m] More...
 
yarp::sig::Vector scans {}
 the scan data, measured in [m]. More...
 
std::int32_t status {0}
 

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 22 of file LaserScan2D.h.

Member Typedef Documentation

◆ unwrapped

typedef yarp::os::idl::Unwrapped<LaserScan2D> yarp::dev::LaserScan2D::unwrapped

Definition at line 76 of file LaserScan2D.h.

Constructor & Destructor Documentation

◆ LaserScan2D() [1/2]

yarp::dev::LaserScan2D::LaserScan2D ( )
default

◆ LaserScan2D() [2/2]

yarp::dev::LaserScan2D::LaserScan2D ( const double  angle_min,
const double  angle_max,
const double  range_min,
const double  range_max,
const yarp::sig::Vector &  scans,
const std::int32_t  status 
)

Definition at line 16 of file LaserScan2D.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::LaserScan2D::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

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 60 of file LaserScan2D.cpp.

◆ read() [2/2]

bool yarp::dev::LaserScan2D::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

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

Definition at line 33 of file LaserScan2D.cpp.

◆ toString()

std::string yarp::dev::LaserScan2D::toString ( ) const

Definition at line 113 of file LaserScan2D.cpp.

◆ write() [1/2]

bool yarp::dev::LaserScan2D::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

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

Definition at line 73 of file LaserScan2D.cpp.

◆ write() [2/2]

bool yarp::dev::LaserScan2D::write ( yarp::os::ConnectionWriter &  writer) const
overridevirtual

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 100 of file LaserScan2D.cpp.

Member Data Documentation

◆ angle_max

double yarp::dev::LaserScan2D::angle_max {0.0}

last angle of the scan [deg]

Definition at line 34 of file LaserScan2D.h.

◆ angle_min

double yarp::dev::LaserScan2D::angle_min {0.0}

first angle of the scan [deg]

Definition at line 30 of file LaserScan2D.h.

◆ range_max

double yarp::dev::LaserScan2D::range_max {0.0}

the maximum distance of the scan [m]

Definition at line 42 of file LaserScan2D.h.

◆ range_min

double yarp::dev::LaserScan2D::range_min {0.0}

the minimum distance of the scan [m]

Definition at line 38 of file LaserScan2D.h.

◆ scans

yarp::sig::Vector yarp::dev::LaserScan2D::scans {}

the scan data, measured in [m].

The angular increment of each ray is obtained by (angle_max-angle_min)/num_of_elements. Invalid data are represented as std::inf.

Definition at line 46 of file LaserScan2D.h.

◆ status

std::int32_t yarp::dev::LaserScan2D::status {0}

Definition at line 47 of file LaserScan2D.h.

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