Public Member Functions | Private Attributes
sick::datastructure::DerivedValues Class Reference

The DerivedValues class Includes the derived configuration of the measurement data channel. More...

#include <DerivedValues.h>

List of all members.

Public Member Functions

 DerivedValues ()
 Constructor of an empty DerivedValues instance.
float getAngularBeamResolution () const
 Returns the angular resolution between the beams.
uint32_t getInterbeamPeriod () const
 Return the time between consecutive beams.
uint16_t getMultiplicationFactor () const
 Return the multiplication factor. Multiplication factor to be applied to the beam distance values to get the distance in millimeter.
uint16_t getNumberOfBeams () const
 Returns the number of beams of the current scan.
uint16_t getScanTime () const
 Return the time of the scan.
float getStartAngle () const
 Get the start angle of the scan.
bool isEmpty () const
 Returns if derived values have been enabled.
void setAngularBeamResolution (const int32_t &angular_beam_resolution)
 Set the angular resolution between beams.
void setInterbeamPeriod (const uint32_t &interbeam_period)
 Set the time between two consecutive beams.
void setIsEmpty (bool is_empty)
 Set if derived values are enabled.
void setMultiplicationFactor (const uint16_t &multiplication_factor)
 Sets the multiplication factor.
void setNumberOfBeams (const uint16_t &number_of_beams)
 Sets the number of beams for the current scan.
void setScanTime (const uint16_t &scan_time)
 Sets the time of the scan.
void setStartAngle (const int32_t &start_angle)
 Set the start angle of the scan.

Private Attributes

const double ANGLE_RESOLUTION = 4194304.0
 Defined angle resolution to convert sensor input to the right frame.
float m_angular_beam_resolution
uint32_t m_interbeam_period
bool m_is_empty
uint16_t m_multiplication_factor
uint16_t m_number_of_beams
uint16_t m_scan_time
float m_start_angle

Detailed Description

The DerivedValues class Includes the derived configuration of the measurement data channel.

Definition at line 48 of file DerivedValues.h.


Constructor & Destructor Documentation

Constructor of an empty DerivedValues instance.

Definition at line 40 of file DerivedValues.cpp.


Member Function Documentation

Returns the angular resolution between the beams.

Returns:
Angular resolution between beams.

Definition at line 86 of file DerivedValues.cpp.

Return the time between consecutive beams.

Returns:
Time between consecutive beams.

Definition at line 96 of file DerivedValues.cpp.

Return the multiplication factor. Multiplication factor to be applied to the beam distance values to get the distance in millimeter.

Returns:
The multiplication factor.

Definition at line 45 of file DerivedValues.cpp.

Returns the number of beams of the current scan.

Returns:
Number of beams.

Definition at line 55 of file DerivedValues.cpp.

Return the time of the scan.

Returns:
Time of the scan.

Definition at line 65 of file DerivedValues.cpp.

Get the start angle of the scan.

Returns:
Start angle of the scan.

Definition at line 76 of file DerivedValues.cpp.

Returns if derived values have been enabled.

Returns:
If derived values have been enabled.

Definition at line 106 of file DerivedValues.cpp.

void sick::datastructure::DerivedValues::setAngularBeamResolution ( const int32_t &  angular_beam_resolution)

Set the angular resolution between beams.

Parameters:
angular_beam_resolutionThe angular resolution between two beams.

Definition at line 91 of file DerivedValues.cpp.

void sick::datastructure::DerivedValues::setInterbeamPeriod ( const uint32_t &  interbeam_period)

Set the time between two consecutive beams.

Parameters:
interbeam_periodTime between two consecutive beams.

Definition at line 101 of file DerivedValues.cpp.

Set if derived values are enabled.

Parameters:
is_emptyset if derived values are enabled.

Definition at line 111 of file DerivedValues.cpp.

void sick::datastructure::DerivedValues::setMultiplicationFactor ( const uint16_t &  multiplication_factor)

Sets the multiplication factor.

Parameters:
multiplication_factorThe new multiplication factor.

Definition at line 50 of file DerivedValues.cpp.

void sick::datastructure::DerivedValues::setNumberOfBeams ( const uint16_t &  number_of_beams)

Sets the number of beams for the current scan.

Parameters:
number_of_beamsNumber of beams for the scan.

Definition at line 60 of file DerivedValues.cpp.

void sick::datastructure::DerivedValues::setScanTime ( const uint16_t &  scan_time)

Sets the time of the scan.

Parameters:
scan_timeTime of the scan.

Definition at line 70 of file DerivedValues.cpp.

void sick::datastructure::DerivedValues::setStartAngle ( const int32_t &  start_angle)

Set the start angle of the scan.

Parameters:
start_angleStart angle of the scan.

Definition at line 81 of file DerivedValues.cpp.


Member Data Documentation

const double sick::datastructure::DerivedValues::ANGLE_RESOLUTION = 4194304.0 [private]

Defined angle resolution to convert sensor input to the right frame.

Definition at line 146 of file DerivedValues.h.

Definition at line 154 of file DerivedValues.h.

Definition at line 155 of file DerivedValues.h.

Definition at line 148 of file DerivedValues.h.

Definition at line 150 of file DerivedValues.h.

Definition at line 151 of file DerivedValues.h.

Definition at line 152 of file DerivedValues.h.

Definition at line 153 of file DerivedValues.h.


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


sick_safetyscanners
Author(s): Lennart Puck
autogenerated on Tue May 7 2019 03:27:37