HokuyoAIST 3.0.2
hokuyoaist Namespace Reference

Classes

class  ArgError
 Bad argument error class. More...
 
class  BaseError
 General error class. More...
 
class  BaudrateError
 Baudrate error class. More...
 
class  ChecksumError
 Bad checksum error. More...
 
class  CloseError
 Close error class. More...
 
class  CommandEchoError
 Command echo error. More...
 
class  DataCountError
 Incorrect number of data sets read error. More...
 
class  EndStepError
 Bad end step error class. More...
 
class  FirmwareError
 Bad firmware error class. More...
 
class  IndexError
 Bad index error class. More...
 
class  InsufficientBytesError
 Insufficient bytes to calculate checksum error. More...
 
struct  IPAddr
 Structure to store an IP address. More...
 
class  LineLengthError
 Incorrect line length error. More...
 
class  LogicError
 Logic error class. More...
 
class  MisplacedLineFeedError
 Misplaced line feed error. More...
 
class  MissingFirmSpecError
 Missing firmware specification error. More...
 
class  MotorSpeedError
 Invalid motor speed error class. More...
 
class  NoDataError
 No data error class. More...
 
class  NoDestinationError
 No destination error class. More...
 
class  NotSerialError
 Not a serial connection error class. More...
 
class  ParamEchoError
 Parameter echo error. More...
 
class  ParseError
 Parse error. More...
 
class  ProtocolError
 Base protocol error. More...
 
class  ReadError
 Read error class. More...
 
class  ResponseError
 Bad response error - may be sent in response to any command. More...
 
class  RuntimeError
 Runtime error class. More...
 
class  ScanData
 Structure to store data returned from the laser scanner. More...
 
class  Scip1ResponseError
 Bad response error (SCIP1 version) More...
 
class  ScipVersionError
 SCIP version error class. More...
 
class  Sensor
 Hokuyo laser scanner class. More...
 
class  SensorInfo
 Sensor information. More...
 
class  SetIPError
 Set IP error class. More...
 
class  StartStepError
 Bad start step error class. More...
 
class  UnknownLineError
 UnknownLine error. More...
 
class  UnknownScipVersionError
 Unknown SCIP version error class. More...
 
class  UnsupportedError
 Unsupported feature error class. More...
 
class  WriteError
 Write error class. More...
 

Typedefs

typedef struct hokuyoaist::IPAddr IPAddr
 Structure to store an IP address.
 

Enumerations

enum  MultiechoMode {
  ME_OFF , ME_FRONT , ME_MIDDLE , ME_REAR ,
  ME_AVERAGE
}
 Possible values of the multiecho mode setting. More...
 
enum  LaserModel {
  MODEL_URG04LX , MODEL_UBG04LXF01 , MODEL_UHG08LX , MODEL_UTM30LX ,
  MODEL_UXM30LXE , MODEL_UNKNOWN
}
 Laser models. More...
 
enum  RotationDirection { CLOCKWISE , COUNTERCLOCKWISE }
 Sensor direction of rotation. More...
 

Functions

std::string scip2_error_to_string (char const *const error, char const *const cmd)
 Translates a SCIP2 error code into a string.
 
std::string desc_code_to_string (unsigned int code)
 Translates an error description code into a string.
 
HOKUYOAIST_EXPORT char const * multiecho_mode_to_string (MultiechoMode mode)
 
HOKUYOAIST_EXPORT char const * model_to_string (LaserModel model)
 
HOKUYOAIST_EXPORT LaserModel string_to_model (char const *model)
 
HOKUYOAIST_EXPORT char const * rot_dir_to_string (RotationDirection dir)
 
double RTOD (double rad)
 
double DTOR (double deg)
 
template<typename T>
median (std::vector< T > &v)
 Find the median value of a std::vector.
 

Variables

double const M_PI = 3.14159265358979323846
 

Typedef Documentation

◆ IPAddr

typedef struct hokuyoaist::IPAddr hokuyoaist::IPAddr

Structure to store an IP address.

Enumeration Type Documentation

◆ LaserModel

Laser models.

Enumerator
MODEL_URG04LX 
MODEL_UBG04LXF01 
MODEL_UHG08LX 
MODEL_UTM30LX 
MODEL_UXM30LXE 
MODEL_UNKNOWN 

Definition at line 58 of file sensor_info.h.

◆ MultiechoMode

Possible values of the multiecho mode setting.

The Tough-URG features multiecho detection capability. To use this, set the sensor to use any mode other than ME_OFF. The sensor can register up to three echos for a single reading. The multiecho mode determines how these are combined into a single value:

  • ME_FRONT: only the closest reading will be used.
  • ME_MIDDLE: the middle reading will be used, or the closest reading if there are only two echos.
  • ME_REAR: the furthest reading will be used.
  • ME_AVERAGE: the average of all two or three echos will be used. In all cases, if there is only one echo, then this setting has no effect.
Enumerator
ME_OFF 
ME_FRONT 
ME_MIDDLE 
ME_REAR 
ME_AVERAGE 

Definition at line 73 of file sensor.h.

◆ RotationDirection

Sensor direction of rotation.

Enumerator
CLOCKWISE 
COUNTERCLOCKWISE 

Definition at line 107 of file sensor_info.h.

Function Documentation

◆ desc_code_to_string()

std::string hokuyoaist::desc_code_to_string ( unsigned int code)

Translates an error description code into a string.

◆ DTOR()

double hokuyoaist::DTOR ( double deg)
inline

Definition at line 73 of file utils.h.

◆ median()

template<typename T>
T hokuyoaist::median ( std::vector< T > & v)
inline

Find the median value of a std::vector.

Definition at line 82 of file utils.h.

◆ model_to_string()

HOKUYOAIST_EXPORT char const * hokuyoaist::model_to_string ( LaserModel model)
inline

Definition at line 69 of file sensor_info.h.

◆ multiecho_mode_to_string()

HOKUYOAIST_EXPORT char const * hokuyoaist::multiecho_mode_to_string ( MultiechoMode mode)
inline

Definition at line 83 of file sensor.h.

◆ rot_dir_to_string()

HOKUYOAIST_EXPORT char const * hokuyoaist::rot_dir_to_string ( RotationDirection dir)
inline

Definition at line 114 of file sensor_info.h.

◆ RTOD()

double hokuyoaist::RTOD ( double rad)
inline

Definition at line 66 of file utils.h.

◆ scip2_error_to_string()

std::string hokuyoaist::scip2_error_to_string ( char const *const error,
char const *const cmd )

Translates a SCIP2 error code into a string.

◆ string_to_model()

HOKUYOAIST_EXPORT LaserModel hokuyoaist::string_to_model ( char const * model)
inline

Definition at line 89 of file sensor_info.h.

Variable Documentation

◆ M_PI

double const hokuyoaist::M_PI = 3.14159265358979323846

Definition at line 62 of file utils.h.