rec::robotino::api2 C++ interface
Public Member Functions | Public Attributes | List of all members
rec::robotino::api2::LaserRangeFinderReadings Class Reference

Sensor readings of Robotino's (optional) laser rangefinder. More...

#include <LaserRangeFinderReadings.h>

Public Member Functions

 LaserRangeFinderReadings ()
 
 LaserRangeFinderReadings (const LaserRangeFinderReadings &other)
 
 ~LaserRangeFinderReadings ()
 
LaserRangeFinderReadingsoperator= (const LaserRangeFinderReadings &other)
 
const char * frame_id () const
 
void set_frame_id (const char *frame_id)
 
void ranges (const float **readings, unsigned int *rangesSize=NULL) const
 
void setRanges (const float *ranges, unsigned int rangesSize)
 
unsigned int numRanges () const
 
void clearRanges ()
 
void intensities (const float **readings, unsigned int *intensitiesSize=NULL) const
 
void setIntensities (const float *intensities, unsigned int intensitiesSize)
 
unsigned int numIntensities () const
 
void clearIntensities ()
 

Public Attributes

unsigned int seq
 
unsigned int stamp
 
float angle_min
 
float angle_max
 
float angle_increment
 
float time_increment
 
float scan_time
 
float range_min
 
float range_max
 

Detailed Description

Sensor readings of Robotino's (optional) laser rangefinder.

Constructor & Destructor Documentation

rec::robotino::api2::LaserRangeFinderReadings::LaserRangeFinderReadings ( )
inline

Constructs an empty LaserRangeFinderReadings instance.

rec::robotino::api2::LaserRangeFinderReadings::LaserRangeFinderReadings ( const LaserRangeFinderReadings other)
inline

Copies an existing LaserRangeFinderReadings instance.

References set_frame_id(), setIntensities(), and setRanges().

rec::robotino::api2::LaserRangeFinderReadings::~LaserRangeFinderReadings ( )
inline

Destructor

Member Function Documentation

void rec::robotino::api2::LaserRangeFinderReadings::clearIntensities ( )
inline

Clears the intensity data.

void rec::robotino::api2::LaserRangeFinderReadings::clearRanges ( )
inline

Clears the range data.

const char* rec::robotino::api2::LaserRangeFinderReadings::frame_id ( ) const
inline
Returns
The frame id.
void rec::robotino::api2::LaserRangeFinderReadings::intensities ( const float **  readings,
unsigned int *  intensitiesSize = NULL 
) const
inline

Retrieves the intensity array.

Parameters
readingsArray of intensities.
intensitiesSizeNumber of intensities.
unsigned int rec::robotino::api2::LaserRangeFinderReadings::numIntensities ( ) const
inline
Returns
Number of intensities.
unsigned int rec::robotino::api2::LaserRangeFinderReadings::numRanges ( ) const
inline
Returns
Number of ranges.
LaserRangeFinderReadings& rec::robotino::api2::LaserRangeFinderReadings::operator= ( const LaserRangeFinderReadings other)
inline
void rec::robotino::api2::LaserRangeFinderReadings::ranges ( const float **  readings,
unsigned int *  rangesSize = NULL 
) const
inline

Retrieves the range array.

Parameters
readingsArray of ranges.
rangesSizeNumber of ranges.
void rec::robotino::api2::LaserRangeFinderReadings::set_frame_id ( const char *  frame_id)
inline

Sets the frame id.

Parameters
frame_idThe frame id.

Referenced by LaserRangeFinderReadings(), and operator=().

void rec::robotino::api2::LaserRangeFinderReadings::setIntensities ( const float *  intensities,
unsigned int  intensitiesSize 
)
inline

Sets the intensity array.

Parameters
intensitiesArray of intensities.
intensitiesSizeNumber of intensities.

Referenced by LaserRangeFinderReadings(), and operator=().

void rec::robotino::api2::LaserRangeFinderReadings::setRanges ( const float *  ranges,
unsigned int  rangesSize 
)
inline

Sets the range array.

Parameters
rangesArray of ranges.
rangesSizeNumber of ranges.

Referenced by LaserRangeFinderReadings(), and operator=().

Member Data Documentation

float rec::robotino::api2::LaserRangeFinderReadings::angle_increment

Angle increment

Referenced by operator=().

float rec::robotino::api2::LaserRangeFinderReadings::angle_max

Maximum angle

Referenced by operator=().

float rec::robotino::api2::LaserRangeFinderReadings::angle_min

Minimum angle

Referenced by operator=().

float rec::robotino::api2::LaserRangeFinderReadings::range_max

Maximum range

Referenced by operator=().

float rec::robotino::api2::LaserRangeFinderReadings::range_min

Minimum range

Referenced by operator=().

float rec::robotino::api2::LaserRangeFinderReadings::scan_time

Scan time

unsigned int rec::robotino::api2::LaserRangeFinderReadings::seq

Sequence number

Referenced by operator=().

unsigned int rec::robotino::api2::LaserRangeFinderReadings::stamp

Time stamp

Referenced by operator=().

float rec::robotino::api2::LaserRangeFinderReadings::time_increment

Time increment

Referenced by operator=().


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