Field data for warning and protective fields. More...

#include <FieldData.h>

Public Member Functions
	FieldData ()
	The constructor of the field data. More...

float	getAngularBeamResolution () const
	Returns the angular resolution between the beams. More...

std::vector< uint16_t >	getBeamDistances () const
	Returns vector with beam distances. More...

float	getEndAngle () const
	Get the end angle of the scan. More...

uint8_t	getEvalMethod () const
	Returns the configured eval method. More...

std::string	getFieldName () const
	Gets the current field name. More...

uint16_t	getFieldSetIndex () const
	Returns the index of the field set the field belongs to. More...

bool	getIsDefined () const
	Returns if the received field data is defined. More...

bool	getIsProtectiveField () const
	Returns if a field is a protective field. More...

bool	getIsValid () const
	Returns if the received field data is valid. More...

bool	getIsWarningField () const
	Returns if a field is warning field. More...

uint16_t	getMultiSampling () const
	Returns the multiple sampling of the field. More...

uint32_t	getNameLength () const
	Gets the length of the field name. More...

uint16_t	getObjectResolution () const
	Returns the configured object resolution. More...

float	getStartAngle () const
	Get the start angle of the scan. More...

std::string	getVersionCVersion () const
	Gets the version indicator for the scanner. More...

uint8_t	getVersionMajorVersionNumber () const
	Gets the major version number for the scanner. More...

uint8_t	getVersionMinorVersionNumber () const
	Gets the minor version number for the scanner. More...

uint8_t	getVersionReleaseNumber () const
	Gets the version release number for the scanner. More...

void	setAngularBeamResolution (const int32_t &angular_beam_resolution)
	Set the angular resolution between beams. More...

void	setAngularBeamResolutionDegrees (const float &angular_beam_resolution)
	Set the angular resolution between beams from degrees. More...

void	setBeamDistances (const std::vector< uint16_t > &beam_distances)
	Sets vector with beam distances for field. More...

void	setEndAngle (const int32_t &end_angle)
	Set the end angle of the scan. More...

void	setEndAngleDegrees (const float &end_angle)
	Set the end angle of the scan from degrees. More...

void	setEvalMethod (const uint8_t &eval_method)
	Sets the configured eval method. More...

void	setFieldName (const std::string &field_name)
	Sets the field name. More...

void	setFieldSetIndex (const uint16_t &field_set_index)
	Sets the index of the field set where the field belongs to. More...

void	setIsDefined (bool is_defined)
	Sets if the field data is defined. More...

void	setIsProtectiveField (bool is_protective_field)
	Set if a field is protective field. More...

void	setIsValid (bool is_valid)
	Sets if the field data is valid. More...

void	setIsWarningField (bool is_warning_field)
	Set if a field is a warning field. More...

void	setMultiSampling (const uint16_t &multi_sampling)
	Sets the configured multiple sampling of the field. More...

void	setNameLength (const uint32_t &name_length)
	Sets the length of the field name. More...

void	setObjectResolution (const uint16_t &object_resolution)
	Sets the configured object resolution. More...

void	setStartAngle (const int32_t &start_angle)
	Set the start angle of the scan. More...

void	setStartAngleDegrees (const float &start_angle)
	Set the start angle of the scan from degrees. More...

void	setVersionCVersion (const std::string &version_c_version)
	Sets the version indicator for the scanner. More...

void	setVersionMajorVersionNumber (const uint8_t &version_major_version_number)
	Sets the major version number for the scanner. More...

void	setVersionMinorVersionNumber (const uint8_t &version_minor_version_number)
	Sets the minor version number for the scanner. More...

void	setVersionReleaseNumber (const uint8_t &version_release_number)
	Sets the version release number for the scanner. More...

Private Attributes
const double	m_ANGLE_RESOLUTION = 4194304.0
	Defined angle resolution to convert sensor input to the right frame. More...

float	m_angular_beam_resolution

std::vector< uint16_t >	m_beam_distances

float	m_end_angle

uint8_t	m_eval_method

std::string	m_field_name

uint16_t	m_field_set_index

bool	m_is_defined

bool	m_is_protective_field

bool	m_is_valid

bool	m_is_warning_field

uint16_t	m_multi_sampling

uint32_t	m_name_length

uint16_t	m_object_resolution

float	m_start_angle

std::string	m_version_c_version

uint8_t	m_version_major_version_number

uint8_t	m_version_minor_version_number

uint8_t	m_version_release_number

Detailed Description

Field data for warning and protective fields.

Definition at line 48 of file FieldData.h.

Constructor & Destructor Documentation

sick::datastructure::FieldData::FieldData ( )

The constructor of the field data.

Definition at line 40 of file FieldData.cpp.

Member Function Documentation

float sick::datastructure::FieldData::getAngularBeamResolution ( ) const

Returns the angular resolution between the beams.

Returns: Angular resolution between beams.

Definition at line 223 of file FieldData.cpp.

std::vector< uint16_t > sick::datastructure::FieldData::getBeamDistances ( ) const

Returns vector with beam distances.

Returns: Vector with beam distances.

Definition at line 183 of file FieldData.cpp.

float sick::datastructure::FieldData::getEndAngle ( ) const

Get the end angle of the scan.

Returns: End angle of the scan.

Definition at line 208 of file FieldData.cpp.

uint8_t sick::datastructure::FieldData::getEvalMethod ( ) const

Returns the configured eval method.

Returns: The eval method.

Definition at line 102 of file FieldData.cpp.

std::string sick::datastructure::FieldData::getFieldName ( ) const

Gets the current field name.

Returns: The current field name.

Definition at line 152 of file FieldData.cpp.

uint16_t sick::datastructure::FieldData::getFieldSetIndex ( ) const

Returns the index of the field set the field belongs to.

Returns: The index of the field set the field belongs to.

Definition at line 132 of file FieldData.cpp.

bool sick::datastructure::FieldData::getIsDefined ( ) const

Returns if the received field data is defined.

Returns: If the received field data is defined.

Definition at line 92 of file FieldData.cpp.

bool sick::datastructure::FieldData::getIsProtectiveField ( ) const

Returns if a field is a protective field.

Returns: If a field is protective.

Definition at line 173 of file FieldData.cpp.

bool sick::datastructure::FieldData::getIsValid ( ) const

Returns if the received field data is valid.

Returns: If the received field data is valid.

Definition at line 42 of file FieldData.cpp.

bool sick::datastructure::FieldData::getIsWarningField ( ) const

Returns if a field is warning field.

Returns: If field is a warning field.

Definition at line 163 of file FieldData.cpp.

uint16_t sick::datastructure::FieldData::getMultiSampling ( ) const

Returns the multiple sampling of the field.

Returns: The configured multiple sampling for this field.

Definition at line 112 of file FieldData.cpp.

uint32_t sick::datastructure::FieldData::getNameLength ( ) const

Gets the length of the field name.

Returns: The length of the field name.

Definition at line 142 of file FieldData.cpp.

uint16_t sick::datastructure::FieldData::getObjectResolution ( ) const

Returns the configured object resolution.

Returns: The configured object resolution.

Definition at line 122 of file FieldData.cpp.

float sick::datastructure::FieldData::getStartAngle ( ) const

Get the start angle of the scan.

Returns: Start angle of the scan.

Definition at line 193 of file FieldData.cpp.

std::string sick::datastructure::FieldData::getVersionCVersion ( ) const

Gets the version indicator for the scanner.

Returns: The version indicator for the scanner.

Definition at line 52 of file FieldData.cpp.

uint8_t sick::datastructure::FieldData::getVersionMajorVersionNumber ( ) const

Gets the major version number for the scanner.

Returns: The version indicator for the scanner.

Definition at line 62 of file FieldData.cpp.

uint8_t sick::datastructure::FieldData::getVersionMinorVersionNumber ( ) const

Gets the minor version number for the scanner.

Returns: The minor version number for the scanner.

Definition at line 72 of file FieldData.cpp.

uint8_t sick::datastructure::FieldData::getVersionReleaseNumber ( ) const

Gets the version release number for the scanner.

Returns: The version release number for the scanner.

Definition at line 82 of file FieldData.cpp.

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

Set the angular resolution between beams.

Parameters

angular_beam_resolution The angular resolution between two beams.

Definition at line 228 of file FieldData.cpp.

void sick::datastructure::FieldData::setAngularBeamResolutionDegrees ( const float & angular_beam_resolution )

Set the angular resolution between beams from degrees.

Parameters

angular_beam_resolution The angular resolution between two beams in degrees.

Definition at line 233 of file FieldData.cpp.

void sick::datastructure::FieldData::setBeamDistances ( const std::vector< uint16_t > & beam_distances )

Sets vector with beam distances for field.

Parameters

beam_distances New beam distances for field.

Definition at line 188 of file FieldData.cpp.

void sick::datastructure::FieldData::setEndAngle ( const int32_t & end_angle )

Set the end angle of the scan.

Parameters

end_angle End angle of the scan.

Definition at line 213 of file FieldData.cpp.

void sick::datastructure::FieldData::setEndAngleDegrees ( const float & end_angle )

Set the end angle of the scan from degrees.

Parameters

end_angle End angle of the scan in degrees.

Definition at line 218 of file FieldData.cpp.

void sick::datastructure::FieldData::setEvalMethod ( const uint8_t & eval_method )

Sets the configured eval method.

Parameters

eval_method The configured eval method.

Definition at line 107 of file FieldData.cpp.

void sick::datastructure::FieldData::setFieldName ( const std::string & field_name )

Sets the field name.

Parameters

field_name The field name.

Definition at line 157 of file FieldData.cpp.

void sick::datastructure::FieldData::setFieldSetIndex ( const uint16_t & field_set_index )

Sets the index of the field set where the field belongs to.

Parameters

field_set_index The index of the field set where the field belongs to.

Definition at line 137 of file FieldData.cpp.

void sick::datastructure::FieldData::setIsDefined ( bool is_defined )

Sets if the field data is defined.

Parameters

is_defined if the field data is defined.

Definition at line 97 of file FieldData.cpp.

void sick::datastructure::FieldData::setIsProtectiveField ( bool is_protective_field )

Set if a field is protective field.

Parameters

is_protective_field Set if a field is a protective field.

Definition at line 178 of file FieldData.cpp.

void sick::datastructure::FieldData::setIsValid ( bool is_valid )

Sets if the field data is valid.

Parameters

is_valid if the field data is valid.

Definition at line 47 of file FieldData.cpp.

void sick::datastructure::FieldData::setIsWarningField ( bool is_warning_field )

Set if a field is a warning field.

Parameters

is_warning_field Set if a field is a warning field.

Definition at line 168 of file FieldData.cpp.

void sick::datastructure::FieldData::setMultiSampling ( const uint16_t & multi_sampling )

Sets the configured multiple sampling of the field.

Parameters

multi_sampling The configured multiple sampling.

Definition at line 117 of file FieldData.cpp.

void sick::datastructure::FieldData::setNameLength ( const uint32_t & name_length )

Sets the length of the field name.

Parameters

name_length The length of the field name.

Definition at line 147 of file FieldData.cpp.

void sick::datastructure::FieldData::setObjectResolution ( const uint16_t & object_resolution )

Sets the configured object resolution.

Parameters

object_resolution The configured object resolution.

Definition at line 127 of file FieldData.cpp.

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

Set the start angle of the scan.

Parameters

start_angle Start angle of the scan.

Definition at line 198 of file FieldData.cpp.

void sick::datastructure::FieldData::setStartAngleDegrees ( const float & start_angle )

Set the start angle of the scan from degrees.

Parameters

start_angle Start angle of the scan in degrees.

Definition at line 203 of file FieldData.cpp.

void sick::datastructure::FieldData::setVersionCVersion ( const std::string & version_c_version )

Sets the version indicator for the scanner.

Parameters

version_c_version The version indicator for the scanner.

Definition at line 57 of file FieldData.cpp.

void sick::datastructure::FieldData::setVersionMajorVersionNumber ( const uint8_t & version_major_version_number )

Sets the major version number for the scanner.

Parameters

version_major_version_number The major version number for the scanner.

Definition at line 67 of file FieldData.cpp.

void sick::datastructure::FieldData::setVersionMinorVersionNumber ( const uint8_t & version_minor_version_number )

Sets the minor version number for the scanner.

Parameters

version_minor_version_number The minor version number for the scanner.

Definition at line 77 of file FieldData.cpp.

void sick::datastructure::FieldData::setVersionReleaseNumber ( const uint8_t & version_release_number )

Sets the version release number for the scanner.

Parameters

version_release_number The version release number for the scanner.

Definition at line 87 of file FieldData.cpp.

Member Data Documentation

const double sick::datastructure::FieldData::m_ANGLE_RESOLUTION = 4194304.0

private

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

Definition at line 318 of file FieldData.h.

float sick::datastructure::FieldData::m_angular_beam_resolution

private

Definition at line 337 of file FieldData.h.

std::vector<uint16_t> sick::datastructure::FieldData::m_beam_distances

private

Definition at line 334 of file FieldData.h.

float sick::datastructure::FieldData::m_end_angle

private

Definition at line 336 of file FieldData.h.

uint8_t sick::datastructure::FieldData::m_eval_method

private

Definition at line 326 of file FieldData.h.

std::string sick::datastructure::FieldData::m_field_name

private

Definition at line 331 of file FieldData.h.

uint16_t sick::datastructure::FieldData::m_field_set_index

private

Definition at line 329 of file FieldData.h.

bool sick::datastructure::FieldData::m_is_defined

private

Definition at line 325 of file FieldData.h.

bool sick::datastructure::FieldData::m_is_protective_field

private

Definition at line 333 of file FieldData.h.

bool sick::datastructure::FieldData::m_is_valid

private

Definition at line 324 of file FieldData.h.

bool sick::datastructure::FieldData::m_is_warning_field

private

Definition at line 332 of file FieldData.h.

uint16_t sick::datastructure::FieldData::m_multi_sampling

private

Definition at line 327 of file FieldData.h.

uint32_t sick::datastructure::FieldData::m_name_length

private

Definition at line 330 of file FieldData.h.

uint16_t sick::datastructure::FieldData::m_object_resolution

private

Definition at line 328 of file FieldData.h.

float sick::datastructure::FieldData::m_start_angle

private

Definition at line 335 of file FieldData.h.

std::string sick::datastructure::FieldData::m_version_c_version

private

Definition at line 320 of file FieldData.h.

uint8_t sick::datastructure::FieldData::m_version_major_version_number

private

Definition at line 321 of file FieldData.h.

uint8_t sick::datastructure::FieldData::m_version_minor_version_number

private

Definition at line 322 of file FieldData.h.

uint8_t sick::datastructure::FieldData::m_version_release_number

private

Definition at line 323 of file FieldData.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation