hokuyo Namespace Reference

A namespace containing the hokuyo device driver. More...

Classes
class	Laser
	A class for interfacing to an SCIP2.0-compliant Hokuyo laser device. More...
struct	LaserConfig
	A struct for returning configuration from the Hokuyo. More...
struct	LaserScan
	A struct for returning laser readings from the Hokuyo. More...
Functions
	DEF_EXCEPTION (Exception, std::runtime_error)
	A standard Hokuyo exception.
	DEF_EXCEPTION (TimeoutException, Exception)
	An exception for use when a timeout is exceeded.
	DEF_EXCEPTION (CorruptedDataException, Exception)
	An exception for use when data is corrupted.
	DEF_EXCEPTION (RepeatedTimeException, Exception)
	An exception for use when the timestamp on the data is repeating (a good indicator something has gone wrong)
Variables
const int	MAX_CMD_LEN = 100
	The maximum length a command will ever be.
const uint32_t	MAX_READINGS = 1128
	The maximum number of readings that can be returned from a hokuyo.
const int	MAX_SKIPPED = 1000000
	The maximum number of bytes that should be skipped when looking for a response.

---

Detailed Description

A namespace containing the hokuyo device driver.

---

Function Documentation

hokuyo::DEF_EXCEPTION	(	Exception	,
		std::runtime_error
	)

A standard Hokuyo exception.

hokuyo::DEF_EXCEPTION	(	TimeoutException	,
		Exception
	)

An exception for use when a timeout is exceeded.

hokuyo::DEF_EXCEPTION	(	CorruptedDataException	,
		Exception
	)

An exception for use when data is corrupted.

hokuyo::DEF_EXCEPTION	(	RepeatedTimeException	,
		Exception
	)

An exception for use when the timestamp on the data is repeating (a good indicator something has gone wrong)

---

Variable Documentation

const int hokuyo::MAX_CMD_LEN = 100

The maximum length a command will ever be.

Definition at line 42 of file hokuyo.h.

const uint32_t hokuyo::MAX_READINGS = 1128

The maximum number of readings that can be returned from a hokuyo.

Definition at line 39 of file hokuyo.h.

const int hokuyo::MAX_SKIPPED = 1000000

The maximum number of bytes that should be skipped when looking for a response.

Definition at line 45 of file hokuyo.h.