INTRODUCTION
Overview
Download and Install
Documentation
Publications

REPOSITORY
Libraries

DEVELOPER
Dev Guide
Dashboard

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

hokuyo_aist::HokuyoData Class Reference

Structure to store data returned from the laser scanner. More...

#include <hokuyo_aist.h>

Inherited by HokuyoDataWrap.

List of all members.

Public Member Functions

 HokuyoData (void)
 This constructor creates an empty HokuyoData with no data currently allocated.
 HokuyoData (uint32_t *ranges, unsigned int length, bool error, unsigned int time)
 This constructor performs a deep copy of range data.
 HokuyoData (uint32_t *ranges, uint32_t *intensities, unsigned int length, bool error, unsigned int time)
 This constructor performs a deep copy of range and intensity data.
 HokuyoData (const HokuyoData &rhs)
 This copy constructor performs a deep copy of present data.
const uint32_t * Ranges (void) const
 Return a pointer to an array of range readings in millimetres.
const uint32_t * Intensities (void) const
 Return a pointer to an array of intensity readings.
unsigned int Length (void) const
 Get the number of samples in the data.
bool GetErrorStatus (void) const
 Indicates if one or more steps had an error.
std::string ErrorCodeToString (uint32_t errorCode)
 Return a string representing the error for the given error code.
unsigned int TimeStamp (void) const
 Get the time stamp of the data in milliseconds (only available using SCIP version 2).
HokuyoDataoperator= (const HokuyoData &rhs)
 Assignment operator.
uint32_t operator[] (unsigned int index)
 Subscript operator. Provides direct access to an element of the range data.
std::string AsString (void)
 Format the entire object into a string.
void CleanUp (void)
 Force the data to clean up.


Detailed Description

Structure to store data returned from the laser scanner.


Member Function Documentation

bool hokuyo_aist::HokuyoData::GetErrorStatus ( void   )  const [inline]

Indicates if one or more steps had an error.

A step's value will be less than 20 if it had an error. Use ErrorCodeToString to get a textual representation of the error.

const uint32_t* hokuyo_aist::HokuyoData::Ranges ( void   )  const [inline]

Return a pointer to an array of range readings in millimetres.

Values less than 20mm indicate an error. Check the error value for the data to see a probable cause for the error. Most of the time, it will just be an out-of-range reading.


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

Generated for GearBox by  doxygen 1.4.5