eduart::device::SensorBoard Class Reference

One sensor board on a bus: holds configured devices and receives COM callbacks for enumeration and data. More...

#include <SensorBoard.hpp>

Inheritance diagram for eduart::device::SensorBoard:

Collaboration diagram for eduart::device::SensorBoard:

Public Member Functions
	SensorBoard (SensorBoardParams params, com::ComInterfaceID interface, unsigned int idx, std::vector< std::unique_ptr< BaseDevice > > devices)
	Construct the board with parameters, communication interface, index, and owned devices.
	~SensorBoard ()
	Destructor.
bool	isEnumerated () const
	Report whether this board has completed enumeration.
const EnumerationInformation &	getEnumInfo () const
	Return the enumeration info received from the hardware.
SensorBoardType	getBoardType () const
	Board type from configuration (undefined if not set). Used for topology enforcement.
std::vector< BaseDevice * >	getDevices () const
	Return non-owning pointers to all devices on this board.

Detailed Description

One sensor board on a bus: holds configured devices and receives COM callbacks for enumeration and data.

Constructor & Destructor Documentation

SensorBoard()

eduart::device::SensorBoard::SensorBoard	(	SensorBoardParams	params,
		com::ComInterfaceID	interface,
		unsigned int	idx,
		std::vector< std::unique_ptr< BaseDevice > >	devices )

Construct the board with parameters, communication interface, index, and owned devices.

Parameters

[in]	params	Board configuration (pose, device params).
[in]	interface	Communication interface ID for this board.
[in]	idx	Board index on the bus.
[in]	devices	Owned devices (sensors/actuators) on this board.

Member Function Documentation

getBoardType()

SensorBoardType eduart::device::SensorBoard::getBoardType

(

)

const

Board type from configuration (undefined if not set). Used for topology enforcement.

Returns

Board type.

getDevices()

std::vector< BaseDevice * > eduart::device::SensorBoard::getDevices

(

)

const

Return non-owning pointers to all devices on this board.

Returns

Vector of BaseDevice pointers.

getEnumInfo()

const EnumerationInformation & eduart::device::SensorBoard::getEnumInfo

(

)

const

Return the enumeration info received from the hardware.

Returns

Const reference to enumeration information.

isEnumerated()

bool eduart::device::SensorBoard::isEnumerated

(

)

const

Report whether this board has completed enumeration.

Returns

true if enumeration response has been received.

---

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

• SensorBoard.hpp