Dokumentacja klasy SerialPortReader

Modeluje pojęcie czytnika danych z poru szeregowego. Więcej...

#include <serialportreader.h>

Diagram dziedziczenia dla SerialPortReader

Diagram współpracy dla SerialPortReader:

Sloty publiczne
void	openSerialPort ()
	Otwiera port szeregowy. Więcej...
void	closeSerialPort ()
	Zamyka port szeregowy. Więcej...
void	readDataFromSerial ()
	Oczytuje dane z portu szeregowego. Więcej...
void	serialErrorHandler (QSerialPort::SerialPortError errorMessage)
	Obsługuje błędy podczas transmisji. Więcej...

Sygnały
void	newData (rawData data)
	Sygnał pojawienia się donych danych. Więcej...
void	portOpened ()
	Sygnał poprawnego otwarcia portu. Więcej...
void	portClosed ()
	Sygnał zamknięcia portu. Więcej...
void	portError (QString errorMessage)
	Sygnał wystąpienia błędu podczas komunikacji z portem. Więcej...

Metody publiczne
	SerialPortReader (QObject *parent=nullptr)
	Konstruktor klasy SerialPortReader. Więcej...
	~SerialPortReader ()
	Desktruktor klasy SerialPortReader. Więcej...
QSettings *	serialSettings ()
	Dostęp do ustawień portu szeregowego. Więcej...
bool	getPortOpened ()
	Zwraca wartość flagi otwarcia portu. Więcej...
void	setPortOpened (bool isOpened)
	Ustawia wartość flagi otwarcia portu. Więcej...

Atrybuty prywatne
QSettings *	_serialSettings
	Wskaźnik do ustawień portu szeregowego. Więcej...
QSerialPort *	_serial
	Uchwyt do portu szeregowego. Więcej...
bool	_portOpened
	Flaga otwarcia portu. Więcej...

Opis szczegółowy

Klasa ta definiuje czytnik danych z portu szeregowego. Pozwala na odczyt danych z portu, którego parametry zostały wcześniej skonfigurowane. Pobiera dane z urządenia i przesyła je surowe do

Definicja w linii 23 pliku serialportreader.h.

Dokumentacja konstruktora i destruktora

SerialPortReader::SerialPortReader ( QObject *  parent = nullptr )

explicit

Inicjalizuje pola klasy oraz łaczy sygnały i sloty gotowości danych oraz wystąpienia błedu.

Parametry

parent

- rodzic obiektu

Definicja w linii 12 pliku serialportreader.cpp.

Oto graf wywołań dla tej funkcji:

SerialPortReader::~SerialPortReader

(

)

Definicja w linii 22 pliku serialportreader.cpp.

Dokumentacja funkcji składowych

void SerialPortReader::closeSerialPort ( )

slot

Zamyka port szeregowy jeżeli jest otwarty. Ustawia flagę _portOpened na false i emituje sygnał portClosed.

Definicja w linii 45 pliku serialportreader.cpp.

Oto graf wywoływań tej funkcji:

bool SerialPortReader::getPortOpened ( )

inline

Zwraca wartość flagi, mówiącej czy port jest otwarty, czy nie.

Zwracane wartości

true	- gdy port jest otwarty
false	- gdy port jest zamknięty

Definicja w linii 52 pliku serialportreader.h.

Oto graf wywoływań tej funkcji:

void SerialPortReader::newData ( rawData  data )

signal

Sygnał wywoływany jest, gdy są już gotowe dane odczytane z czujników. Dane muszą być przekazane w ściśle określonej kolejności - najpierw odczyt danych z 3 osi akcelerometru, następnie wartośći na 3 osiach z żyroskopu, a na końcu interwał czasowu pomiędzy pomiarami. Wszystko oddzielone spacją lub innym znakiem białym.

Parametry

[in]

data

- W parametrze przekazywane są nowo odczytane dane.

Oto graf wywoływań tej funkcji:

void SerialPortReader::openSerialPort ( )

slot

Otwiera port szeregowy na podstawie danych zapisanych w konfiguracji poru szeregowego. Gdy port zostanie otwarty zostaje ustawiawna flaga _portOpened na true i emitowany jest sygnał portOpened(). W przeciwnym wypadku flaga ma wartość false i emitowany jest sygnał portError(QString) przekazujący informację o błędzie.

Definicja w linii 28 pliku serialportreader.cpp.

Oto graf wywoływań tej funkcji:

void SerialPortReader::portClosed ( )

signal

Gdy port zostanie zamknięty sygnał ten tej emitowany.

Oto graf wywoływań tej funkcji:

void SerialPortReader::portError ( QString  errorMessage )

signal

Sygnał jest emitowany, gdy wystąpi jakiś bład z komunikacją.

Parametry

[in]

errorMessage

- W parametrze przekazywana jest informacja o błędzie.

Oto graf wywoływań tej funkcji:

void SerialPortReader::portOpened ( )

signal

Gdy port zostanie poprawnie otwarty sygnał ten tej emitowany.

Oto graf wywoływań tej funkcji:

void SerialPortReader::readDataFromSerial ( )

slot

Gdy dane są gotowe do odczytu, slot ten jest wykonywany. Odczytuje on wszystkie dane z portu szeregowego i emituje je przez sygnał newData(rawData)

Definicja w linii 54 pliku serialportreader.cpp.

Oto graf wywoływań tej funkcji:

void SerialPortReader::serialErrorHandler ( QSerialPort::SerialPortError  errorMessage )

slot

Służy do obsługi błędów jakie zgłasza port szeregowy i emituje go poprzez emitowanie sygnału portError(QString).

Parametry

[in]

errorMessage

- błąd zgłoszony przez port szeregowy

Definicja w linii 78 pliku serialportreader.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

QSettings* SerialPortReader::serialSettings ( )

inline

Metoda umożliwia dostęp do ustawień portu szeregowego.

Zwraca

Ustawienia portu szeregowego.

Definicja w linii 44 pliku serialportreader.h.

Oto graf wywoływań tej funkcji:

void SerialPortReader::setPortOpened ( bool  isOpened )

inline

Ustawia flagę na wartość przekazaną w argumencie funckji.

Parametry

[in]

isOpened

- wartość do ustawienia flagi otwarcia portu

Definicja w linii 59 pliku serialportreader.h.

Oto graf wywołań dla tej funkcji:

Dokumentacja atrybutów składowych

bool SerialPortReader::_portOpened

private

Flaga otwarcia portu. True - gdy otwarty, False, gdy zamknięty.

Definicja w linii 144 pliku serialportreader.h.

QSerialPort* SerialPortReader::_serial

private

Uchwyt do portu szeregowego.

Definicja w linii 138 pliku serialportreader.h.

QSettings* SerialPortReader::_serialSettings

private

Wskaźnik do ustawień portu szeregowego.

Definicja w linii 132 pliku serialportreader.h.

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• serialportreader.h
• serialportreader.cpp