#include <courses.h>

Diagram dziedziczenia dla Courses

Diagram współpracy dla Courses:

Sloty publiczne
void	spawnCourse ()
	Dodaje kurs na ekran. Więcej...

void	moveCourses ()
	Przesuwa kursy widoczne na scenie w dół okna. Więcej...

void	on_Course_failedCourse (Course *pCourse)
	Obsługa niezaliczonego przedmiotu. Więcej...

void	on_Course_passedCourse (Course *pCourse)
	Obsługa zaliczonego przedmiotu. Więcej...

Sygnały
void	increaseDeficit (int ECTS)
	Zwiększenie deficytu. Więcej...

void	decreaseDeficit (int ECTS)
	Zmniejszenie deficytu. Więcej...

void	increaseECTS (int ECTS)
	Zwiększenie liczby punktów ECTS. Więcej...

void	changeTerm (int term)
	Zmiana semestru. Więcej...

void	failedToReadData ()
	Błąd wczytywania danych z plików zasobów. Więcej...

void	checkDeficitOverstep ()
	Sprawdzenie przekroczenia deficytu. Więcej...

void	gameFinished ()
	Zakończenie gry. Więcej...

Metody publiczne
	Courses (GameSettings gSettings, QObject parent=nullptr)
	Konstruktor klasy Courses. Więcej...

	~Courses ()
	Destruktor klasy Courses. Więcej...

QList< QList< Course * > * >	getAllTerms ()
	Umożliwa dostęp do wszystkich semestrów. Więcej...

bool	readCoursesFormDisc (GameSettings *gSettings)
	Wczytanie wszystkich kursów z plików. Więcej...

Atrybuty prywatne
int	_actualTermIndex
	Indeks aktualnego semestru. Więcej...

bool	_failedToReadData
	Flaga błędu odczytu danych kursów z zasobów. Więcej...

QList< Course * >	_courseListToMove
	Lista aktualnie wyświetlanych na ekranie kursów. Więcej...

QList< Course * >	_courseListToRepeat
	Lista kursów do poprawy. Więcej...

QList< QList< Course * > * >	_allTerms
	Lista semestrów z wszystkimi nierealizowanymi do tej pory kursami. Więcej...

QMediaPlayer *	player
	Odtwarzacz muzyki. Więcej...

Opis szczegółowy

Klasa modeluje pojęcie wszystkiech kursów. Dziedziczy po klasie QGraphicsRectItem. Służy ona do przechowywania wszystkich kursów podczas danej gry. Obsługuje wczytywanie kursów z plików oraz dodawanie ich na scenę gry.

Definicja w linii 26 pliku courses.h.

Dokumentacja konstruktora i destruktora

Courses::Courses	(	GameSettings *	gSettings,
		QObject *	parent = `nullptr`
	)

explicit

Inicjalizuje kursy. Ustawia zmienne oraz uruchamia funkcję wczytująca wszystkie kursy do gry.

Parametry

[in]	gSettings	- ustawienia globalne gry
	parent	- rodzic

Definicja w linii 15 pliku courses.cpp.

Oto graf wywołań dla tej funkcji:

Courses::~Courses ( )

Definicja w linii 28 pliku courses.cpp.

Dokumentacja funkcji składowych

void Courses::changeTerm ( int term )

signal

Sygnał emitowany, gdy należy zmienić aktualny semestr.

Parametry

[in] term - Przekazuje w parametrze semestr jaki należy ustawić.

Oto graf wywoływań tej funkcji:

void Courses::checkDeficitOverstep ( )

signal

Sygnał wysyłany jest w momencie, kiedy należy sprawdzić, czy został przekroczony deficyt.

Oto graf wywoływań tej funkcji:

void Courses::decreaseDeficit ( int ECTS )

signal

Sygnał emitowany, gdy należy zmiejszyć licznik deficytu punktów.

Parametry

[in] ECTS - Przekazuje w parametrze liczbę punktów o jaką należy zmniejszyć deficyt.

Oto graf wywoływań tej funkcji:

void Courses::failedToReadData ( )

signal

Syngał emitowany, gdy wystapił jakiś błąd podczas czytania danych kursów z zasobów.

Oto graf wywoływań tej funkcji:

void Courses::gameFinished ( )

signal

Sygnał wysyłany, gdy lista z kursami jest już pusta, więc gra się zakończyła.

Oto graf wywoływań tej funkcji:

QList<QList<Course *>*> Courses::getAllTerms ( )

inline

Umożliwia dostęp do wszystkich kursów ze wszystkich semestrów, które są przechowywane w zmiennej _allTerms.

Zwraca: Zwraca listę wszystkich aktualnie przechowywanych semestrów.

Definicja w linii 50 pliku courses.h.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Courses::increaseDeficit ( int ECTS )

signal

Sygnał emitowany, gdy należy zwiększyć licznik deficytu punktów.

Parametry

[in] ECTS - Przekazuje w parametrze liczbę punktów o jaką należy zwiększyć deficyt.

Oto graf wywoływań tej funkcji:

void Courses::increaseECTS ( int ECTS )

signal

Sygnał emitowany, gdy należy zwiększyć licznik zdobytych punktów ECTS.

Parametry

[in] ECTS - Przekazuje w parametrze liczbę punktów o jaką należy zwiększyć sumę punktów.

Oto graf wywoływań tej funkcji:

void Courses::moveCourses ( )

slot

Dla każdego kursu aktualnie wyświetlanego na ekranie wywołuje metodę move()

Definicja w linii 118 pliku courses.cpp.

Oto graf wywoływań tej funkcji:

void Courses::on_Course_failedCourse ( Course * pCourse )

slot

Obsługuje niezaliczony kurs - usuwa obiekt ze sceny oraz listy cursów do przesuwania Course::_courseListToMove i dodaje go do listy kursów do ponownej realizacji _courseListToRepeat. Jeśli kurs jest realizowany po raz pierwszy emituje sygnał increaseDeficit() oraz ustawia flagę Course::_onceMore na true.

Parametry

pCourse - uchwyt do kursu, który nie został zaliczony

Definicja w linii 125 pliku courses.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Courses::on_Course_passedCourse ( Course * pCourse )

slot

Obsługuje zaliczony kurs - zwiększa liczbę ECTSów, usuwa obiekt ze sceny oraz listy cursów do przesuwania Course::_courseListToMove . Jeśli kurs jest poprawiany dodatkowo zmniejsza deficyt punktów.

Parametry

[in] pCourse - uchwyt do kursu, który został zaliczony

Definicja w linii 139 pliku courses.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

bool Courses::readCoursesFormDisc ( GameSettings * gSettings )

Wczytuje nazwy oraz ilość punktów ECTS wszystkich kursów z plików znajdujących się w zasobach. Na podstawie tych danych wypełnia listę _allTerms nowo tworzonymi wskaźnikami na kursy.

Parametry

[in] gSettings - ustawienia globalne (wykorzsytywane przy tworzeniu nowego kursu)

Zwracane wartości

true	- poprawnie wczytano pliki
false	- błąd podczas wczytywania plików

Warunek wstępny: Pliki z kursami (o nazwie "SEM_n.txt") muszą znajdować w zasobach o prefiksie "/terms".

Definicja w linii 42 pliku courses.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Courses::spawnCourse ( )

slot

Slot ten ma bardzo ważne zadanie w całej grze. Dodaje kursy na scenę gry oraz do listy aktywnych kursów do przesuwania po ekranie _courseListToMove . Poza tym pełni funkcje nadzorcze. Po pierwsze sprawdza, czy poprawnie wczytano kursy (flaga _failedToReadData ). Jeżeli nie emituje sygnał failedToReadData() . Dodatkowo sprawdza warunki zakończenia gry i jeśli trzeba emituje sygnał gameFinished(). Ostatnią funckją nadzroczą jest sprawdzanie przekroczenia deficytu i emitowanie w razie potrzeby sygnału deficitOverstep() .

Definicja w linii 74 pliku courses.cpp.

Oto graf wywoływań tej funkcji:

Dokumentacja atrybutów składowych

int Courses::_actualTermIndex

private

Indeks aktualnego semestru

Definicja w linii 161 pliku courses.h.

QList<QList<Course *>*> Courses::_allTerms

private

Lista wskaźników na listy wskaźników na kursy. Zawiera wszystkie kursy, które nie zostały jeszcze zrealizowane. Wczytywana jest podczas inicjalizownia nowej gry, w metodzie readCoursesFormDisc().

Definicja w linii 188 pliku courses.h.

QList<Course *> Courses::_courseListToMove

private

Lista wskaźników do kursów aktualnie wyświetlanych na ekranie (na scenie gry). Służy ona do przechowywania kursów, które należy przesuwać.

Definicja w linii 175 pliku courses.h.

QList<Course *> Courses::_courseListToRepeat

private

Lista wskaźników na kursy, które należy jeszcze poprawić.

Definicja w linii 181 pliku courses.h.

bool Courses::_failedToReadData

private

Flaga błędu odczytu danych kursów z zasobów

Definicja w linii 167 pliku courses.h.

QMediaPlayer* Courses::player

private

Odtwarzacz muzyki służy do odtworzenia dźwięku wpadnięcia na kurs.

Definicja w linii 194 pliku courses.h.

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

Sloty publiczne

Sygnały

Metody publiczne

Atrybuty prywatne

Opis szczegółowy

Dokumentacja konstruktora i destruktora

Dokumentacja funkcji składowych

Dokumentacja atrybutów składowych