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

#include <FieldData.h>

Public Member Functions
	FieldData ()
	The constructor of the field data.
float	getAngularBeamResolution () const
	Returns the angular resolution between the beams.
std::vector< uint16_t >	getBeamDistances () const
	Returns vector with beam distances.
float	getEndAngle () const
	Get the end angle of the scan.
uint16_t	getFieldSetIndex () const
	Returns the index of the field set the field belongs to.
bool	getIsProtectiveField () const
	Returns if a field is a protective field.
bool	getIsValid () const
	Returns if the received field data is valid.
bool	getIsWarningField () const
	Returns if a field is warning field.
float	getStartAngle () const
	Get the start angle of the scan.
void	setAngularBeamResolution (const int32_t &angular_beam_resolution)
	Set the angular resolution between beams.
void	setAngularBeamResolutionDegrees (const float &angular_beam_resolution)
	Set the angular resolution between beams from degrees.
void	setBeamDistances (const std::vector< uint16_t > &beam_distances)
	Sets vector with beam distances for field.
void	setEndAngle (const int32_t &end_angle)
	Set the end angle of the scan.
void	setEndAngleDegrees (const float &end_angle)
	Set the end angle of the scan from degrees.
void	setFieldSetIndex (uint16_t &field_set_index)
	Sets the index of the field set where the field belongs to.
void	setIsProtectiveField (bool is_protective_field)
	Set if a field is protective field.
void	setIsValid (bool is_valid)
	Sets if the field data is valid.
void	setIsWarningField (bool is_warning_field)
	Set if a field is a warning field.
void	setStartAngle (const int32_t &start_angle)
	Set the start angle of the scan.
void	setStartAngleDegrees (const float &start_angle)
	Set the start angle of the scan from degrees.
Private Attributes
const double	ANGLE_RESOLUTION = 4194304.0
	Defined angle resolution to convert sensor input to the right frame.
float	m_angular_beam_resolution
std::vector< uint16_t >	m_beam_distances
float	m_end_angle
uint16_t	m_field_set_index
bool	m_is_protective_field
bool	m_is_valid
bool	m_is_warning_field
float	m_start_angle

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 122 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 82 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 107 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 52 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 72 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 62 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 92 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 127 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 132 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 87 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 112 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 117 of file FieldData.cpp.

void sick::datastructure::FieldData::setFieldSetIndex ( 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 57 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 77 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 67 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 97 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 102 of file FieldData.cpp.

Member Data Documentation

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

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

Definition at line 184 of file FieldData.h.

float sick::datastructure::FieldData::m_angular_beam_resolution [private]

Definition at line 193 of file FieldData.h.

std::vector<uint16_t> sick::datastructure::FieldData::m_beam_distances [private]

Definition at line 190 of file FieldData.h.

float sick::datastructure::FieldData::m_end_angle [private]

Definition at line 192 of file FieldData.h.

uint16_t sick::datastructure::FieldData::m_field_set_index [private]

Definition at line 187 of file FieldData.h.

bool sick::datastructure::FieldData::m_is_protective_field [private]

Definition at line 189 of file FieldData.h.

bool sick::datastructure::FieldData::m_is_valid [private]

Definition at line 186 of file FieldData.h.

bool sick::datastructure::FieldData::m_is_warning_field [private]

Definition at line 188 of file FieldData.h.

float sick::datastructure::FieldData::m_start_angle [private]

Definition at line 191 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