StudySettings Class Reference

Object for the settings relating to the study sessions component. More...

#include <settings_scene.h>

Public Member Functions
	StudySettings ()
	Construct a new Study Settings object.
	StudySettings (const int &n_cards, const int &mins)
	Construct a new Study Settings object. More...
int	getFlashCardLimit ()
	Get the round limit for flashcards. More...
int	getStudyDurationMin ()
	Get the Study Duration. More...
void	setFlashCardLimit (const int &n_cards)
	Set the maximum number of flashcards per round. More...
void	setStudyDurationMin (const int &mins)
	Set the Study Duration. More...
void	incStudyDuration ()
	increment the study duration by 1 minute
void	decStudyDuration ()
	decrement the study duration by 1 minute
void	incFCLimit ()
	increment the flashcard card round limit by 1
void	decFCLimit ()
	decrement the flashcard card round limit by 1
void	reset ()
	Reset the settings back to the defaults.
void	startSession ()
	Set the start time for the study session.
boolean	sessionUnderway ()
	Determines if the study session is underway. More...
void	endSession ()
	sets the end of the session
std::chrono::steady_clock::time_point	getSessionStart ()
	Get the Session Start time point. More...
std::filesystem::path	getDeckDir ()
	Get the directory the Deck files are stored in. More...

Detailed Description

Object for the settings relating to the study sessions component.

Constructor & Destructor Documentation

StudySettings()

StudySettings::StudySettings	(	const int &	n_cards,
		const int &	mins
	)

Construct a new Study Settings object.

Parameters

n_cards	max number of cards per round
mins	duration of the study session

Member Function Documentation

getDeckDir()

std::filesystem::path StudySettings::getDeckDir

(

)

Get the directory the Deck files are stored in.

Returns

std::filesystem::path

getFlashCardLimit()

int StudySettings::getFlashCardLimit

(

)

Get the round limit for flashcards.

Returns

int

getSessionStart()

std::chrono::steady_clock::time_point StudySettings::getSessionStart

(

)

Get the Session Start time point.

Returns

std::chrono::steady_clock::time_point

getStudyDurationMin()

int StudySettings::getStudyDurationMin

(

)

Get the Study Duration.

Returns

int

sessionUnderway()

boolean StudySettings::sessionUnderway

(

)

Determines if the study session is underway.

Returns

boolean

setFlashCardLimit()

void StudySettings::setFlashCardLimit

(

const int &

n_cards

)

Set the maximum number of flashcards per round.

Parameters

n_cards

number of cards

setStudyDurationMin()

void StudySettings::setStudyDurationMin

(

const int &

mins

)

Set the Study Duration.

Parameters

mins	number of minutes

---

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

• /home/runner/work/StudyDungeon/StudyDungeon/src/settings_scene.h
• /home/runner/work/StudyDungeon/StudyDungeon/src/settings_scene.cpp