sick::datastructure::ScanPoint Class Reference

Class containing the data of a single scan point. More...

#include <ScanPoint.h>

List of all members.

Public Member Functions
float	getAngle () const
	Getter for the angle in sensor coordinates.
bool	getContaminationBit () const
	Returns if the scanpoint is contaminated.
bool	getContaminationWarningBit () const
	Returns if there is a contamination warning.
uint16_t	getDistance () const
	Getter for the distance of the scanpoint.
bool	getGlareBit () const
	Returns if the scanpoint has glare.
bool	getInfiniteBit () const
	Returns if the scanpoint is infinite.
uint8_t	getReflectivity () const
	Getter for the reflectivity value.
bool	getReflectorBit () const
	Returns if the scanpoint detects a reflector.
bool	getValidBit () const
	Returns if the scanpoint is valid.
	ScanPoint ()
	ScanPoint (float angle, int16_t &distance, uint8_t &reflectivity, bool &valid_bit, bool &infinite_bit, bool &glare_bit, bool &reflector_bit, bool &contamination_bit, bool &contamination_warning_bit)
	Constructor of a scan point, takes all needed parameters.
Private Attributes
float	m_angle
bool	m_contamination_bit
bool	m_contamination_warning_bit
int16_t	m_distance
bool	m_glare_bit
bool	m_infinite_bit
uint8_t	m_reflectivity
bool	m_reflector_bit
bool	m_valid_bit

---

Detailed Description

Class containing the data of a single scan point.

Definition at line 46 of file ScanPoint.h.

---

Constructor & Destructor Documentation

sick::datastructure::ScanPoint::ScanPoint

(

)

Definition at line 40 of file ScanPoint.cpp.

sick::datastructure::ScanPoint::ScanPoint	(	float	angle,
		int16_t &	distance,
		uint8_t &	reflectivity,
		bool &	valid_bit,
		bool &	infinite_bit,
		bool &	glare_bit,
		bool &	reflector_bit,
		bool &	contamination_bit,
		bool &	contamination_warning_bit
	)

Constructor of a scan point, takes all needed parameters.

Parameters:

angle	Angle of the scanpoint in coordinates of the sensor.
distance	Distance of the measured scanpoint.
reflectivity	Value how strongly the scan point reflects.
valid_bit	If the scanpoint is valid.
infinite_bit	If the scanpoint is infinite.
glare_bit	If there is glare in the scanpoint.
reflector_bit	If the scanpoint detects a reflector.
contamination_bit	If the scanpoint is contaminated.
contamination_warning_bit	Warning if the scanpoint is contaminated.

Definition at line 42 of file ScanPoint.cpp.

---

Member Function Documentation

float sick::datastructure::ScanPoint::getAngle

(

)

const

Getter for the angle in sensor coordinates.

Returns:

The angle of the sensor scanpoint.

Definition at line 63 of file ScanPoint.cpp.

bool sick::datastructure::ScanPoint::getContaminationBit

(

)

const

Returns if the scanpoint is contaminated.

Returns:

If the scanpoint is contaminated.

Definition at line 98 of file ScanPoint.cpp.

bool sick::datastructure::ScanPoint::getContaminationWarningBit

(

)

const

Returns if there is a contamination warning.

Returns:

If there is a contamination warning.

Definition at line 103 of file ScanPoint.cpp.

uint16_t sick::datastructure::ScanPoint::getDistance

(

)

const

Getter for the distance of the scanpoint.

Returns:

The distance of the scanpoint.

Definition at line 68 of file ScanPoint.cpp.

bool sick::datastructure::ScanPoint::getGlareBit

(

)

const

Returns if the scanpoint has glare.

Returns:

If the scanpoint has glare.

Definition at line 88 of file ScanPoint.cpp.

bool sick::datastructure::ScanPoint::getInfiniteBit

(

)

const

Returns if the scanpoint is infinite.

Returns:

If the scanpoint is infinite.

Definition at line 83 of file ScanPoint.cpp.

uint8_t sick::datastructure::ScanPoint::getReflectivity

(

)

const

Getter for the reflectivity value.

Returns:

The reflectivity value of the scanpoint.

Definition at line 73 of file ScanPoint.cpp.

bool sick::datastructure::ScanPoint::getReflectorBit

(

)

const

Returns if the scanpoint detects a reflector.

Returns:

If the scanpoint is a reflector.

Definition at line 93 of file ScanPoint.cpp.

bool sick::datastructure::ScanPoint::getValidBit

(

)

const

Returns if the scanpoint is valid.

Returns:

If the scanpoint is valid.

Definition at line 78 of file ScanPoint.cpp.

---

Member Data Documentation

float sick::datastructure::ScanPoint::m_angle [private]

Definition at line 129 of file ScanPoint.h.

bool sick::datastructure::ScanPoint::m_contamination_bit [private]

Definition at line 136 of file ScanPoint.h.

bool sick::datastructure::ScanPoint::m_contamination_warning_bit [private]

Definition at line 137 of file ScanPoint.h.

int16_t sick::datastructure::ScanPoint::m_distance [private]

Definition at line 130 of file ScanPoint.h.

bool sick::datastructure::ScanPoint::m_glare_bit [private]

Definition at line 134 of file ScanPoint.h.

bool sick::datastructure::ScanPoint::m_infinite_bit [private]

Definition at line 133 of file ScanPoint.h.

uint8_t sick::datastructure::ScanPoint::m_reflectivity [private]

Definition at line 131 of file ScanPoint.h.

bool sick::datastructure::ScanPoint::m_reflector_bit [private]

Definition at line 135 of file ScanPoint.h.

bool sick::datastructure::ScanPoint::m_valid_bit [private]

Definition at line 132 of file ScanPoint.h.

---

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

• ScanPoint.h
• ScanPoint.cpp