Classes | Typedefs | Functions
SickToolbox Namespace Reference

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

Classes

class  SickBadChecksumException
 Thrown when a received message has an invalid checksum. More...
class  SickBufferMonitor
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  SickException
 Provides a base exception class from which to derive other Sick exceptions. More...
class  SickIOException
 Thrown instance where the driver can't read,write,drain,flush,... the buffers. 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  SickLIDAR
 Provides an abstract parent for all Sick LIDAR devices. More...
class  SickLMS1xx
 Provides a simple driver interface for working with the Sick LD-OEM/Sick LD-LRS long-range models via Ethernet. More...
class  SickLMS1xxBufferMonitor
 A class for monitoring the receive buffer when interfacing with a Sick LD LIDAR. More...
class  SickLMS1xxMessage
 A class to represent all messages sent to and from the Sick LMS 1xx unit. More...
class  SickLMS2xx
 A general class for interfacing w/ SickLMS2xx2xx laser range finders. More...
class  SickLMS2xxBufferMonitor
 A class for monitoring the receive buffer when interfacing with a Sick LMS LIDAR. More...
class  SickLMS2xxMessage
 A class to represent all messages sent to and from the Sick LMS 2xx. More...
class  SickMessage
 Provides an abstract parent for all Sick messages. More...
class  SickThreadException
 Thrown when error occurs during thread initialization, and uninitialization. More...
class  SickTimeoutException
 Makes handling timeouts much easier. More...

Typedefs

typedef
SickLMS1xx::sick_lms_1xx_scan_format_t 
sick_lms_1xx_scan_format_t
 Makes working w/ SickLMS1xx::sick_lms_1xx_scan_format_t a bit easier.
typedef
SickLMS1xx::sick_lms_1xx_scan_freq_t 
sick_lms_1xx_scan_freq_t
 Makes working w/ SickLMS1xx::sick_lms_1xx_scan_freq_t a bit easier.
typedef
SickLMS1xx::sick_lms_1xx_scan_res_t 
sick_lms_1xx_scan_res_t
 Makes working w/ SickLMS1xx::sick_lms_1xx_scan_res_t a bit easier.
typedef
SickLMS1xx::sick_lms_1xx_status_t 
sick_lms_1xx_status_t
 Makes working w/ SickLMS1xx::sick_lms_1xx_status_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_baud_t 
sick_lms_2xx_baud_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_baud_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_measuring_mode_t 
sick_lms_2xx_measuring_mode_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_measuring_mode_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_measuring_units_t 
sick_lms_2xx_measuring_units_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_measuring_units_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_operating_mode_t 
sick_lms_2xx_operating_mode_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_operating_mode_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_peak_threshold_t 
sick_lms_2xx_peak_threshold_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_peak_threshold_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_scan_angle_t 
sick_lms_2xx_scan_angle_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_scan_angle_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_scan_resolution_t 
sick_lms_2xx_scan_resolution_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_scan_resolution_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_sensitivity_t 
sick_lms_2xx_sensitivity_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_sensitivity_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_status_t 
sick_lms_2xx_status_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_status_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_type_t 
sick_lms_2xx_type_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_type_t a bit easier.
typedef
SickLMS2xx::sick_lms_2xx_variant_t 
sick_lms_2xx_variant_t
 Makes working w/ SickLMS2xx::sick_lms_2xx_variant_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 host_to_sick_lms_1xx_byte_order (uint16_t value)
 Converts host byte order (little-endian) to Sick LMS byte order (little-endian)
uint32_t host_to_sick_lms_1xx_byte_order (uint32_t value)
 Converts host byte order (little-endian) to Sick LMS byte order (little-endian)
uint16_t host_to_sick_lms_2xx_byte_order (uint16_t value)
 Converts host byte order (little-endian) to Sick LMS byte order (little-endian)
uint32_t host_to_sick_lms_2xx_byte_order (uint32_t value)
 Converts host byte order (little-endian) to Sick LMS byte order (little-endian)
std::string int_to_str (const int value)
 Utility function for converting int to standard string.
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 sick_lms_1xx_to_host_byte_order (uint16_t value)
 Converts Sick LMS byte order (little-endian) to host byte order (little-endian)
uint32_t sick_lms_1xx_to_host_byte_order (uint32_t value)
 Converts Sick LMS byte order (little-endian) to host byte order (little-endian)
uint16_t sick_lms_2xx_to_host_byte_order (uint16_t value)
 Converts Sick LMS byte order (little-endian) to host byte order (little-endian)
uint32_t sick_lms_2xx_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

Makes working w/ SickLMS1xx::sick_lms_1xx_scan_format_t a bit easier.

Definition at line 318 of file SickLMS1xx.hh.

Makes working w/ SickLMS1xx::sick_lms_1xx_scan_freq_t a bit easier.

Definition at line 324 of file SickLMS1xx.hh.

Makes working w/ SickLMS1xx::sick_lms_1xx_scan_res_t a bit easier.

Definition at line 330 of file SickLMS1xx.hh.

Makes working w/ SickLMS1xx::sick_lms_1xx_status_t a bit easier.

Definition at line 312 of file SickLMS1xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_baud_t a bit easier.

Definition at line 992 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_measuring_mode_t a bit easier.

Definition at line 980 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_measuring_units_t a bit easier.

Definition at line 956 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_operating_mode_t a bit easier.

Definition at line 986 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_peak_threshold_t a bit easier.

Definition at line 968 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_scan_angle_t a bit easier.

Definition at line 944 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_scan_resolution_t a bit easier.

Definition at line 950 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_sensitivity_t a bit easier.

Definition at line 962 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_status_t a bit easier.

Definition at line 974 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_type_t a bit easier.

Definition at line 932 of file SickLMS2xx.hh.

Makes working w/ SickLMS2xx::sick_lms_2xx_variant_t a bit easier.

Definition at line 938 of file SickLMS2xx.hh.


Function Documentation

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:
valueThe 2-byte value to convert to big-endian
Returns:
Value in Sick LD byte order (big-endian)

Definition at line 45 of file SickLDUtility.hh.

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:
valueThe 4-byte value to convert to big-endian
Returns:
Value in Sick LD byte order (big-endian)

Definition at line 54 of file SickLDUtility.hh.

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

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

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

Definition at line 49 of file SickLMS1xxUtility.hh.

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

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

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

Definition at line 58 of file SickLMS1xxUtility.hh.

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

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

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

Definition at line 46 of file SickLMS2xxUtility.hh.

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

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

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

Definition at line 55 of file SickLMS2xxUtility.hh.

std::string SickToolbox::int_to_str ( const int  value) [inline]

Utility function for converting int to standard string.

Parameters:
valueInteger to be converted
Returns:
String representing the given integer

Definition at line 129 of file SickLMS1xxUtility.hh.

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:
valueThe 2-byte value to convert to little-endian
Returns:
Value in host byte order (little-endian)

Definition at line 63 of file SickLDUtility.hh.

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:
valueThe 4-byte value to convert to little-endian
Returns:
Value in host byte order (little-endian)

Definition at line 72 of file SickLDUtility.hh.

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

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

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

Definition at line 67 of file SickLMS1xxUtility.hh.

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

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

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

Definition at line 76 of file SickLMS1xxUtility.hh.

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

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

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

Definition at line 64 of file SickLMS2xxUtility.hh.

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

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

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

Definition at line 73 of file SickLMS2xxUtility.hh.



sicktoolbox
Author(s): Jason Derenick , Thomas Miller
autogenerated on Thu Aug 27 2015 15:17:16