sensor::vl6180::LaeVL6180SensorInfo Class Reference

Container class to hold VL6180 time-of-flight sensor static information. More...

#include <laeVL6180.h>

Public Member Functions
	LaeVL6180SensorInfo ()
	Default constructor.
	LaeVL6180SensorInfo (int nIndex, int nChan, double fBeamDir, double fDeadzone, const std::string &strDesc)
	Initialization constructor. More...
	LaeVL6180SensorInfo (const LaeVL6180SensorInfo &src)
	Copy constructor. More...
	~LaeVL6180SensorInfo ()
	Destructor.
LaeVL6180SensorInfo	operator= (const LaeVL6180SensorInfo &rhs)
	Assignment operator. More...
void	getProps (int &nIndex, int &nChan, std::string &strRadiationType, double &fFoV, double &fBeamDir, double &fDeadzone, double &fMin, double &fMax, std::string &strDesc)
	Get sensor properties. More...

Public Attributes
int	m_nIndex
	sensor index
int	m_nChan
	multiplexed channel number
double	m_fBeamDir
	center of beam direction(radians)
double	m_fDeadzone
	sensor deadzone (m)
std::string	m_strDesc
	short description

Detailed Description

Container class to hold VL6180 time-of-flight sensor static information.

Definition at line 280 of file laeVL6180.h.

Constructor & Destructor Documentation

LaeVL6180SensorInfo::LaeVL6180SensorInfo	(	int	nIndex,
		int	nChan,
		double	fBeamDir,
		double	fDeadzone,
		const std::string &	strDesc
	)

Initialization constructor.

Parameters

nIndex	Sensor index. May be remapped if order of wired sensors change.
nChan	Mulitplexed channel number.
fBeamDir	Center of IR beam direction (radians).
fDeadzone	Sense deadzone range.
strDesc	Short description (e.g. location).

Definition at line 119 of file laeVL6180.cxx.

{
  m_nIndex    = nIndex;
  m_nChan     = nChan;
  m_fBeamDir  = fBeamDir;
  m_fDeadzone = fDeadzone;
  m_strDesc   = strDesc;
}

LaeVL6180SensorInfo::LaeVL6180SensorInfo

(

const LaeVL6180SensorInfo &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 132 of file laeVL6180.cxx.

References m_fBeamDir, m_fDeadzone, m_nChan, m_nIndex, and m_strDesc.

{
  m_nIndex    = src.m_nIndex;
  m_nChan     = src.m_nChan;
  m_fBeamDir  = src.m_fBeamDir;
  m_fDeadzone = src.m_fDeadzone;
  m_strDesc   = src.m_strDesc;
}

Member Function Documentation

void LaeVL6180SensorInfo::getProps	(	int &	nIndex,
		int &	nChan,
		std::string &	strRadiationType,
		double &	fFoV,
		double &	fBeamDir,
		double &	fDeadzone,
		double &	fMin,
		double &	fMax,
		std::string &	strDesc
	)

Get sensor properties.

Parameters

[out]	nIndex	Sensor index.
[out]	nChan	Mulitplexed channel number.
[out]	strRadiationType	Radiation type.
[out]	fFoV	Field of View (radians).
[out]	fBeamDir	Center of IR beam direction (radians).
[out]	fDeadzone	Sense deadzone range.
[out]	fMin	Minimum range (meters).
[out]	fMax	Maximum range (meters).
[out]	strDesc	Short description (e.g. location).

Definition at line 157 of file laeVL6180.cxx.

References laelaps::degToRad(), VL6180X_RANGE_FOV, VL6180X_RANGE_MAX, and VL6180X_RANGE_MIN.

{
  nIndex            = m_nIndex;
  nChan             = m_nChan;
  strRadiationType  = "infrared";
  fFoV              = degToRad(VL6180X_RANGE_FOV);
  fBeamDir          = m_fBeamDir;
  fDeadzone         = m_fDeadzone;
  fMin              = VL6180X_RANGE_MIN;
  fMax              = VL6180X_RANGE_MAX;
  strDesc           = m_strDesc;
}

LaeVL6180SensorInfo LaeVL6180SensorInfo::operator=

(

const LaeVL6180SensorInfo &

rhs

)

Assignment operator.

Parameters

rhs	Right hand side object.

*this

Definition at line 145 of file laeVL6180.cxx.

References m_fBeamDir, m_fDeadzone, m_nChan, m_nIndex, and m_strDesc.

{
  m_nIndex    = rhs.m_nIndex;
  m_nChan     = rhs.m_nChan;
  m_fBeamDir  = rhs.m_fBeamDir;
  m_fDeadzone = rhs.m_fDeadzone;
  m_strDesc   = rhs.m_strDesc;

  return *this;
}

---

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

• include/Laelaps/laeVL6180.h
• sw/liblaelaps/laeVL6180.cxx