Parameter structure of a sensor board. More...

#include "sensorring/board/SensorBoardType.hpp"
#include "sensorring/math/Math.hpp"
#include "sensorring/platform/SensorringExport.hpp"

Include dependency graph for SensorBoardParams.hpp:

This graph shows which files directly or indirectly include this file:

Classes
struct	eduart::sensorring::board::SensorBoardParams
	Parameter structure of a sensor board. A sensor board is one circuit board. More...

Enumerations
enum class	eduart::sensorring::board::Orientation { None , Left , Right }
	Possible orientations of a sensor board. Used to rotate/mirror light animations and thermal images. More...

Functions
SENSORRING_EXPORT std::string	eduart::sensorring::board::toString (Orientation mode) noexcept
	Function to convert the Orientation enum class members to string.
SENSORRING_EXPORT std::ostream &	eduart::sensorring::board::operator<< (std::ostream &os, Orientation mode) noexcept
	Output stream operator for the Orientation enum class members.

Detailed Description

Parameter structure of a sensor board.

Enumeration Type Documentation

strong

Possible orientations of a sensor board. Used to rotate/mirror light animations and thermal images.

Enumerator
None	No specific orientation; default behaviour applies.
Left	Board is mounted on the left side; animations are mirrored horizontally.
Right	Board is mounted on the right side; animations are used as-is.

SENSORRING_EXPORT std::ostream & eduart::sensorring::board::operator<<	(	std::ostream &	os,
		Orientation	mode )

noexcept

Output stream operator for the Orientation enum class members.

Parameters

[in]	os	output stream to write to
[in]	mode	to be printed as stream

SENSORRING_EXPORT std::string eduart::sensorring::board::toString ( Orientation mode )

noexcept

Function to convert the Orientation enum class members to string.

Parameters

[in] mode to be converted to a string