Dokumentacja klasy ControllerWindow

Klasa ControllerWindow. Więcej...

#include <controllerwindow.h>

Diagram dziedziczenia dla ControllerWindow

Diagram współpracy dla ControllerWindow:

Sygnały
void	connectToSerial ()
	Sygnał połączenia do portu. Więcej...
void	disconnectFromSerial ()
	Sygnał rozłączenia od portu. Więcej...

Metody publiczne
	ControllerWindow (QSettings *serialSettings, QWidget *parent=nullptr)
	Konstruktor ControllerWindow. Więcej...
	~ControllerWindow ()
	Destruktor klasy ControllerWindow. Więcej...
void	update ()
	Aktualizuje stan okna ControllerWindow. Więcej...

Sloty prywatne
void	on_portBox_currentIndexChanged (int index)
	Obsługuje zmianę parametru w obiekcie portBox. Więcej...
void	on_baudRateBox_currentIndexChanged (int index)
	Obsługuje zmianę parametru w obiekcie baudRateBox. Więcej...
void	on_connectButton_clicked ()
	Obsługuje naciśnięcie przycisku "Połącz". Więcej...
void	on_disconnectButton_clicked ()
	Obsługuje naciśnięcie przycisku "Rozłącz". Więcej...
void	on_saveButton_clicked ()
	Obsługuje naciśnięcie przycisku "Zapisz". Więcej...

Metody prywatne
void	showPortInfo (int index)
	Wyświetla informację o aktualnie wybranym porcie. Więcej...
void	checkCustomBaudRate (int index)
	(nieużywana) Sprawdza, czy zaznaczono własą prędkość. Więcej...
void	fillPortsParameters ()
	Wypełnia pola parametrów portu szeregowego. Więcej...
void	fillPortsInfo ()
	Wypełnia dostępne pory i informacje o nich. Więcej...
void	updateSettings ()
	Aktualizuje ustawienia portu szeregowego. Więcej...

Atrybuty prywatne
Ui::ControllerWindow *	_ui
	Interfejs okna. Więcej...
QIntValidator *	_validator
	Walidator wprowadzonych intów (używany przy baudrate) Więcej...
QSettings *	_serialSettings
	Ustawienia portu szeregowego. Więcej...

Opis szczegółowy

Klasa modeluje okno konfiguracyjne portu szeregowego. Udostępnia możliwość wyboru portu oraz ustawienia jego podstawowych parametrów.

Definicja w linii 34 pliku controllerwindow.h.

Dokumentacja konstruktora i destruktora

ControllerWindow::ControllerWindow ( QSettings *  serialSettings, QWidget *  parent = nullptr  )

explicit

Inicjalizuje okno ustawień kontrolera.

Parametry

[in]	serialSettings	- ustawienia portu szeregowego.
[in]	parent	- rodzic okna

Definicja w linii 16 pliku controllerwindow.cpp.

Oto graf wywołań dla tej funkcji:

ControllerWindow::~ControllerWindow

(

)

Definicja w linii 30 pliku controllerwindow.cpp.

Dokumentacja funkcji składowych

void ControllerWindow::checkCustomBaudRate ( int  index )

private

Sprawdza, czy zaznaczono własą prędkość. Jeśli tak, to sprawdza za pomocą Validatora, czy wprowadzona prędkośc transmisji jest poprawna.

Parametry

[in]

index

- numer indeksu, na którym znajduje się interesujący nas port.

Definicja w linii 61 pliku controllerwindow.cpp.

Oto graf wywoływań tej funkcji:

void ControllerWindow::connectToSerial ( )

signal

Sygnał wysyłany w celu połaczenia się z wybranym portem szeregowym.

Oto graf wywoływań tej funkcji:

void ControllerWindow::disconnectFromSerial ( )

signal

Sygnał wysyłany w celu zamkniecia danego portu.

Oto graf wywoływań tej funkcji:

void ControllerWindow::fillPortsInfo ( )

private

Wypełnia ComboBox z aktualnie odstępnymi portami oraz wypisuje dane wybranego portu.

Definicja w linii 110 pliku controllerwindow.cpp.

Oto graf wywoływań tej funkcji:

void ControllerWindow::fillPortsParameters ( )

private

Wypełnia pola ComboBoxów odpowiadajacych za dobór parametrów możliwymi wyborami. Domyślnie ustawia zapisane w ustawieniach _serialSettings parametry.

Definicja w linii 76 pliku controllerwindow.cpp.

Oto graf wywoływań tej funkcji:

void ControllerWindow::on_baudRateBox_currentIndexChanged ( int  index )

privateslot

Slot obsługujący zmianę parametru w obiekcie baudRateBox, pozwalajacym wybrać prędkosć transmisji. Wykorzystywany do sprawdzenia, gdy wybrano opcję Własna(nieużywana opcja), czy jest to liczba typu int.

Wywołuje metode checkCustomBaudRate

Parametry

[out]

index

- indeks wybranego aktualnie pola

Warunek wstępny

Musi istnieć QIntValidator

Definicja w linii 176 pliku controllerwindow.cpp.

Oto graf wywołań dla tej funkcji:

void ControllerWindow::on_connectButton_clicked ( )

privateslot

Obsługuje naciśnięcie przycisku "Połącz" (obiekt Ui_ControllerWindow::connectButton). Aktualizuje ustawienia portów _serialSettings i emituje sygnał connectToSerial() obsługiwany przez slot SerialPortReader::openSerialPort()

Definicja w linii 185 pliku controllerwindow.cpp.

Oto graf wywołań dla tej funkcji:

void ControllerWindow::on_disconnectButton_clicked ( )

privateslot

Obsługuje naciśnięcie przycisku "Rozłącz" (obiekt disconnectButton). Emituje sygnał disconnectFromSerial() obsługiwany przez slot SerialPortReader::closeSerialPort()

Definicja w linii 196 pliku controllerwindow.cpp.

void ControllerWindow::on_portBox_currentIndexChanged ( int  index )

privateslot

Slot obsługujący zmianę parametru w obiekcie portBox, pozwalajacym wybrać interesujący nas port. Wykorzystywany do wyświetlenia następnie informacji o wybranym porcie.

Wywołuje metodę showPortInfo

Parametry

[in]

index

- indeks wybranego aktualnie pola

Definicja w linii 162 pliku controllerwindow.cpp.

Oto graf wywołań dla tej funkcji:

void ControllerWindow::on_saveButton_clicked ( )

privateslot

Obsługuje naciśnięcie przycisku "Zapisz" (obiekt saveButton). Aktualizuje ustawienia portów _serialSettings.

Definicja w linii 205 pliku controllerwindow.cpp.

Oto graf wywołań dla tej funkcji:

void ControllerWindow::showPortInfo ( int  index )

private

Wyświetla informację o aktualnie wybranym porcie.

Parametry

[in]

index

- numer indeksu, na którym znajduje się interesujący nas port.

Definicja w linii 46 pliku controllerwindow.cpp.

Oto graf wywoływań tej funkcji:

void ControllerWindow::update

(

)

Definicja w linii 36 pliku controllerwindow.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void ControllerWindow::updateSettings ( )

private

Aktualizuje ustawienia portu szeregowego przechowywanym pod uchwytem _serialSettings.

Definicja w linii 135 pliku controllerwindow.cpp.

Oto graf wywoływań tej funkcji:

Dokumentacja atrybutów składowych

QSettings* ControllerWindow::_serialSettings

private

Definicja w linii 103 pliku controllerwindow.h.

Ui::ControllerWindow* ControllerWindow::_ui

private

Definicja w linii 95 pliku controllerwindow.h.

QIntValidator* ControllerWindow::_validator

private

Definicja w linii 99 pliku controllerwindow.h.

---

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

• controllerwindow.h
• controllerwindow.cpp