trikHal::HardwareAbstractionInterface Class Reference

Hardware abstraction, provides devices that are used to communicate with robot hardware or emulate it. More...

#include <hardwareAbstractionInterface.h>

Inheritance diagram for trikHal::HardwareAbstractionInterface:

Public Member Functions
	HardwareAbstractionInterface ()=default
virtual	~HardwareAbstractionInterface ()=default
virtual MspI2cInterface &	mspI2c ()=0
	Returns MSP I2C bus implementation. More...
virtual MspUsbInterface &	mspUsb ()=0
	Returns MSP USB bus implementation. More...
virtual SystemConsoleInterface &	systemConsole ()=0
	Returns system console wrapper, able to execute system command and launch processes. More...
virtual EventFileInterface *	createEventFile (const QString &fileName, QThread &thread) const =0
	Creates new event file, passes ownership to a caller. More...
virtual FifoInterface *	createFifo (const QString &fileName) const =0
	Creates new FIFO, passes ownership to a caller. More...
virtual InputDeviceFileInterface *	createInputDeviceFile (const QString &fileName) const =0
	Creates new input device file, passes ownership to a caller. More...
virtual OutputDeviceFileInterface *	createOutputDeviceFile (const QString &fileName) const =0
	Creates new output device file, passes ownership to a caller. More...
virtual QVector< uint8_t >	captureV4l2StillImage (const QString &port, const QString &pathToPic) const =0
	Returns QVector with info about picture pixels. More...

Detailed Description

Hardware abstraction, provides devices that are used to communicate with robot hardware or emulate it.

Constructor & Destructor Documentation

trikHal::HardwareAbstractionInterface::HardwareAbstractionInterface ( )

default

virtual trikHal::HardwareAbstractionInterface::~HardwareAbstractionInterface ( )

virtualdefault

Member Function Documentation

virtual QVector<uint8_t> trikHal::HardwareAbstractionInterface::captureV4l2StillImage ( const QString &  port, const QString &  pathToPic  ) const

pure virtual

Returns QVector with info about picture pixels.

Parameters

port	- port name for device
pathToPic	- path to picture

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

virtual EventFileInterface* trikHal::HardwareAbstractionInterface::createEventFile ( const QString &  fileName, QThread &  thread  ) const

pure virtual

Creates new event file, passes ownership to a caller.

Parameters

fileName	- file name (with path, relative or absolute) of an event file.
thread	- background thread where all socket events will be processed.

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

virtual FifoInterface* trikHal::HardwareAbstractionInterface::createFifo ( const QString &  fileName ) const

pure virtual

Creates new FIFO, passes ownership to a caller.

Parameters

fileName

- file name (with path, relative or absolute) of a FIFO file.

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

virtual InputDeviceFileInterface* trikHal::HardwareAbstractionInterface::createInputDeviceFile ( const QString &  fileName ) const

pure virtual

Creates new input device file, passes ownership to a caller.

Parameters

fileName

- file name (with path, relative or absolute) of a device file.

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

virtual OutputDeviceFileInterface* trikHal::HardwareAbstractionInterface::createOutputDeviceFile ( const QString &  fileName ) const

pure virtual

Creates new output device file, passes ownership to a caller.

Parameters

fileName

- file name (with path, relative or absolute) of a device file.

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

virtual MspI2cInterface& trikHal::HardwareAbstractionInterface::mspI2c ( )

pure virtual

Returns MSP I2C bus implementation.

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

virtual MspUsbInterface& trikHal::HardwareAbstractionInterface::mspUsb ( )

pure virtual

Returns MSP USB bus implementation.

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

virtual SystemConsoleInterface& trikHal::HardwareAbstractionInterface::systemConsole ( )

pure virtual

Returns system console wrapper, able to execute system command and launch processes.

Implemented in trikHal::stub::StubHardwareAbstraction, and trikHal::trik::TrikHardwareAbstraction.

---

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

• trikHal/include/trikHal/hardwareAbstractionInterface.h