SickToolbox Namespace Reference

Encapsulates the Sick LIDAR Matlab/C++ toolbox. More...


Classes

class  SickBufferMonitor
class  SickException
 Provides a base exception class from which to derive other Sick exceptions. More...
class  SickTimeoutException
 Makes handling timeouts much easier. More...
class  SickIOException
 Thrown instance where the driver can't read,write,drain,flush,... the buffers. More...
class  SickBadChecksumException
 Thrown when a received message has an invalid checksum. More...
class  SickThreadException
 Thrown when error occurs during thread initialization, and uninitialization. More...
class  SickConfigException
 Thrown when the driver detects (or the Sick reports) an invalid config. More...
class  SickErrorException
 Thrown when Sick returns an error code or an unexpected response. More...
class  SickLIDAR
 Provides an abstract parent for all Sick LIDAR devices. More...
class  SickMessage
 Provides an abstract parent for all Sick messages. More...
class  SickLD
 Provides a simple driver interface for working with the Sick LD-OEM/Sick LD-LRS long-range models via Ethernet. More...
class  SickLDBufferMonitor
 A class for monitoring the receive buffer when interfacing with a Sick LD LIDAR. More...
class  SickLDMessage
 A class to represent all messages sent to and from the Sick LD unit. More...
class  SickLMS
 A general class for interfacing w/ SickLMS2xx laser range finders. More...
class  SickLMSBufferMonitor
 A class for monitoring the receive buffer when interfacing with a Sick LMS LIDAR. More...
class  SickLMSMessage
 A class to represent all messages sent to and from the Sick LMS 2xx. More...

Typedefs

typedef SickLMS::sick_lms_type_t sick_lms_type_t
 Makes working w/ SickLMS::sick_lms_type_t a bit easier.
typedef SickLMS::sick_lms_variant_t sick_lms_variant_t
 Makes working w/ SickLMS::sick_lms_variant_t a bit easier.
typedef SickLMS::sick_lms_scan_angle_t sick_lms_scan_angle_t
 Makes working w/ SickLMS::sick_lms_scan_angle_t a bit easier.
typedef SickLMS::sick_lms_scan_resolution_t sick_lms_scan_resolution_t
 Makes working w/ SickLMS::sick_lms_scan_resolution_t a bit easier.
typedef SickLMS::sick_lms_measuring_units_t sick_lms_measuring_units_t
 Makes working w/ SickLMS::sick_lms_measuring_units_t a bit easier.
typedef SickLMS::sick_lms_sensitivity_t sick_lms_sensitivity_t
 Makes working w/ SickLMS::sick_lms_sensitivity_t a bit easier.
typedef SickLMS::sick_lms_peak_threshold_t sick_lms_peak_threshold_t
 Makes working w/ SickLMS::sick_lms_peak_threshold_t a bit easier.
typedef SickLMS::sick_lms_status_t sick_lms_status_t
 Makes working w/ SickLMS::sick_lms_status_t a bit easier.
typedef SickLMS::sick_lms_measuring_mode_t sick_lms_measuring_mode_t
 Makes working w/ SickLMS::sick_lms_measuring_mode_t a bit easier.
typedef SickLMS::sick_lms_operating_mode_t sick_lms_operating_mode_t
 Makes working w/ SickLMS::sick_lms_operating_mode_t a bit easier.
typedef SickLMS::sick_lms_baud_t sick_lms_baud_t
 Makes working w/ SickLMS::sick_lms_baud_t a bit easier.

Functions

uint16_t host_to_sick_ld_byte_order (uint16_t value)
 Converts host byte order (little-endian) to Sick LD byte order (big-endian).
uint32_t host_to_sick_ld_byte_order (uint32_t value)
 Converts host byte order (little-endian) to Sick LD byte order (big-endian).
uint16_t sick_ld_to_host_byte_order (uint16_t value)
 Converts Sick LD byte order (big-endian) to host byte order (little-endian).
uint32_t sick_ld_to_host_byte_order (uint32_t value)
 Converts Sick LD byte order (big-endian) to host byte order (little-endian).
uint16_t host_to_sick_lms_byte_order (uint16_t value)
 Converts host byte order (little-endian) to Sick LMS byte order (little-endian).
uint32_t host_to_sick_lms_byte_order (uint32_t value)
 Converts host byte order (little-endian) to Sick LMS byte order (little-endian).
uint16_t sick_lms_to_host_byte_order (uint16_t value)
 Converts Sick LMS byte order (little-endian) to host byte order (little-endian).
uint32_t sick_lms_to_host_byte_order (uint32_t value)
 Converts Sick LMS byte order (little-endian) to host byte order (little-endian).


Detailed Description

Encapsulates the Sick LIDAR Matlab/C++ toolbox.

Typedef Documentation

SickToolbox::sick_lms_baud_t

Makes working w/ SickLMS::sick_lms_baud_t a bit easier.

SickToolbox::sick_lms_measuring_mode_t

Makes working w/ SickLMS::sick_lms_measuring_mode_t a bit easier.

SickToolbox::sick_lms_measuring_units_t

Makes working w/ SickLMS::sick_lms_measuring_units_t a bit easier.

SickToolbox::sick_lms_operating_mode_t

Makes working w/ SickLMS::sick_lms_operating_mode_t a bit easier.

SickToolbox::sick_lms_peak_threshold_t

Makes working w/ SickLMS::sick_lms_peak_threshold_t a bit easier.

SickToolbox::sick_lms_scan_angle_t

Makes working w/ SickLMS::sick_lms_scan_angle_t a bit easier.

SickToolbox::sick_lms_scan_resolution_t

Makes working w/ SickLMS::sick_lms_scan_resolution_t a bit easier.

SickToolbox::sick_lms_sensitivity_t

Makes working w/ SickLMS::sick_lms_sensitivity_t a bit easier.

SickToolbox::sick_lms_status_t

Makes working w/ SickLMS::sick_lms_status_t a bit easier.

SickToolbox::sick_lms_type_t

Makes working w/ SickLMS::sick_lms_type_t a bit easier.

SickToolbox::sick_lms_variant_t

Makes working w/ SickLMS::sick_lms_variant_t a bit easier.


Function Documentation

uint32_t SickToolbox::host_to_sick_ld_byte_order ( uint32_t  value  )  [inline]

Converts host byte order (little-endian) to Sick LD byte order (big-endian).

Parameters:
value The 4-byte value to convert to big-endian
Returns:
Value in Sick LD byte order (big-endian)

uint16_t SickToolbox::host_to_sick_ld_byte_order ( uint16_t  value  )  [inline]

Converts host byte order (little-endian) to Sick LD byte order (big-endian).

Parameters:
value The 2-byte value to convert to big-endian
Returns:
Value in Sick LD byte order (big-endian)

uint32_t SickToolbox::host_to_sick_lms_byte_order ( uint32_t  value  )  [inline]

Converts host byte order (little-endian) to Sick LMS byte order (little-endian).

Parameters:
value The 4-byte value to convert to little-endian
Returns:
Value in Sick LMS byte order (little-endian)

uint16_t SickToolbox::host_to_sick_lms_byte_order ( uint16_t  value  )  [inline]

Converts host byte order (little-endian) to Sick LMS byte order (little-endian).

Parameters:
value The 2-byte value to convert to little-endian
Returns:
Value in Sick LMS byte order (little-endian)

uint32_t SickToolbox::sick_ld_to_host_byte_order ( uint32_t  value  )  [inline]

Converts Sick LD byte order (big-endian) to host byte order (little-endian).

Parameters:
value The 4-byte value to convert to little-endian
Returns:
Value in host byte order (little-endian)

uint16_t SickToolbox::sick_ld_to_host_byte_order ( uint16_t  value  )  [inline]

Converts Sick LD byte order (big-endian) to host byte order (little-endian).

Parameters:
value The 2-byte value to convert to little-endian
Returns:
Value in host byte order (little-endian)

uint32_t SickToolbox::sick_lms_to_host_byte_order ( uint32_t  value  )  [inline]

Converts Sick LMS byte order (little-endian) to host byte order (little-endian).

Parameters:
value The 4-byte value to convert to little-endian
Returns:
Value in host byte order (little-endian)

uint16_t SickToolbox::sick_lms_to_host_byte_order ( uint16_t  value  )  [inline]

Converts Sick LMS byte order (little-endian) to host byte order (little-endian).

Parameters:
value The 2-byte value to convert to little-endian
Returns:
Value in host byte order (little-endian)


Generated on Thu Mar 20 09:41:45 2008 for sicktoolbox-1.0 by  doxygen 1.5.1