Dokumentacja klasy Course

Modeluje pojęcie Course. Więcej...

#include <course.h>

Diagram dziedziczenia dla Course

Diagram współpracy dla Course:

Sygnały
void	passedCourse (Course *pCourse)
	Sygnał zdania kursu. Więcej...
void	failedCourse (Course *pCourse)
	Sygnał niezaliczenia kursu. Więcej...

Metody publiczne
	Course (GameSettings *gSettings, int nOE, QString name, int tN, QObject *parent=nullptr)
	Konstruktor klasy Course. Więcej...
	~Course ()
	Desktruktor klasy Course. Więcej...
int	getNumberOfECTS () const
	Zwraca liczbę ECTSów kursu. Więcej...
int	getTerm () const
	Zwraca semestr kursu. Więcej...
void	setRandomPos ()
	Ustala losową pozycję kursu. Więcej...
bool	isOnceMorePursued () const
	Ponowna realizacja kursu. Więcej...
void	setToRepeat ()
	Ustawia dany kurs jako do poprawy. Więcej...
void	move ()

Atrybuty prywatne
GameSettings *	_gameSettings
	Lokalny uchwyt globalnych ustawień gry Lokalny uchwyt globalnych ustawień gry. Więcej...
int	_numberOfECTS
	Liczba punktów ECTS kursu Liczba punktów ECTS kursu. Więcej...
QString	_courseName
	Nazwa kursu Nazwa kursu. Więcej...
int	_termNumber
	Numer semestru, na którym powinien być kurs Numer semestru, na którym powinien być kurs. Więcej...
qreal	_courseWidth
	Szerokość kursu Szerokość kursu w pikselach. Więcej...
qreal	_courseHeight
	Wysokośc kursu. Więcej...
bool	_onceMore
	Flaga - czy kurs jest poprawiany. Więcej...

Opis szczegółowy

Klasa modeluje pojęcie kursu. Klasa dziedziczy po QGraphicsRecrItem. Kurs jest to prostokąt pojawiający się w polu gry. Na każdym prostokącie pojawia się nazwa kursu, do którego się odnosi. Szerokość kursu jest uzależniona od ilości punktów ECTS za dany kurs. Wysokość kursu ustawiana jest na stałe w konstruktorze.

Definicja w linii 25 pliku course.h.

Dokumentacja konstruktora i destruktora

Course::Course ( GameSettings *  gSettings, int  nOE, QString  name, int  tN, QObject *  parent = nullptr  )

explicit

Inicjalizuje kurs - nadaju mu odpowiednią wielkość oraz nazwę. Dodatkowo ustawia mu losowo początkową pozycję.

Parametry

[in]	gSettings	- globalne ustawienia gry
[in]	nOE	- liczba punktów ECTS za dany kurs
[in]	name	- nazwa kursu
[in]	tN	- numer semestru, do którego należy dany kurs
[in]	parent	- rodzic kursu

Definicja w linii 16 pliku course.cpp.

Oto graf wywołań dla tej funkcji:

Course::~Course

(

)

Definicja w linii 46 pliku course.cpp.

Dokumentacja funkcji składowych

void Course::failedCourse ( Course *  pCourse )

signal

Sygnał wysyłany, gdy kurs nie zostanie zaliczony, tzn. student (gracz) wpadnie w kurs. Zderzenie z kursem realizowane jest poprzez użycie metody collidingItems() z QGraphicsItem.

Parametry

[out]

pCourse

- Przesyła uchwyt do danego kursu

Oto graf wywoływań tej funkcji:

int Course::getNumberOfECTS ( ) const

inline

Definicja w linii 49 pliku course.h.

Oto graf wywoływań tej funkcji:

int Course::getTerm ( ) const

inline

Definicja w linii 53 pliku course.h.

Oto graf wywołań dla tej funkcji:

bool Course::isOnceMorePursued ( ) const

inline

Zwraca wartość, która mówi o tym czy kurs był już realizowany

Zwracane wartości

true	- kurs był już co najmniej raz realizowany
false	- kurs nie był jeszcze realizowany

Definicja w linii 65 pliku course.h.

Oto graf wywoływań tej funkcji:

void Course::move

(

)

Poruszenie kursu o jedną jednostkę

Porusza kurs o jedną zdefiniowaną w tej metodzie jedostkę. Dodatkowo sprawdza, czy kurs został zaliczony, czy nie. W zależności od sytuacji emituje sygnał: passedCourse() lub failedCourse() .

Definicja w linii 57 pliku course.cpp.

Oto graf wywoływań tej funkcji:

void Course::passedCourse ( Course *  pCourse )

signal

Sygnał wysyłany, gdy kurs zostanie zdany, tzn. wydzie poza obszar gry.

Parametry

[out]

pCourse

- Przesyła uchwyt do danego kursu

Oto graf wywoływań tej funkcji:

void Course::setRandomPos

(

)

Definicja w linii 50 pliku course.cpp.

Oto graf wywoływań tej funkcji:

void Course::setToRepeat ( )

inline

Definicja w linii 69 pliku course.h.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

Dokumentacja atrybutów składowych

qreal Course::_courseHeight

private

Wysokośc kursu w pikselach

Definicja w linii 130 pliku course.h.

QString Course::_courseName

private

Definicja w linii 114 pliku course.h.

qreal Course::_courseWidth

private

Definicja w linii 124 pliku course.h.

GameSettings* Course::_gameSettings

private

Definicja w linii 104 pliku course.h.

int Course::_numberOfECTS

private

Definicja w linii 109 pliku course.h.

bool Course::_onceMore

private

Gdy kurs nie zostanie zaliczony ta flaga jest ustawiana na true. Jest nastepnie wykorzystywana do obsługi poprawiania danego kursu (dokładniej by nie odejmować ECTSów dwa razy za ten sam kurs)

Definicja w linii 138 pliku course.h.

int Course::_termNumber

private

Definicja w linii 119 pliku course.h.

---

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

• course.h
• course.cpp