Classe per la gestione del buzzer della radiosveglia. More...

#include <Buzzer.h>

Collaboration diagram for Buzzer:

Static Public Member Functions
static bool	Init (const int &t_BuzzerPin)
	Metodo di inizializzazione dei componenti della classe.

static bool	Bip (const unsigned int &t_Frequency, const unsigned int &t_Duration)
	Genera un'onda quadra della frequenza e durata specificati come parametri.

static bool	BipAutomated (const unsigned int &t_Frequency, const unsigned int &t_Duration)
	AUTOMATIZZATO: Genera un'onda quadra della frequenza e durata specificati come parametri.

Private Member Functions
	Buzzer ()=default
	Costruttore di default della classe Buzzer.

	~Buzzer ()=default
	Distruttore della classe Buzzer.

Static Private Attributes
static int	m_BuzzerPin = Buzzer__file::_nopin

static bool	m_hasBeenCalled = false

Detailed Description

Classe per la gestione del buzzer della radiosveglia.

La seguente classe fornisce tutti i metodi necessari alla gestione di un buzzer, utilizzato per la riproduzione di un "bip" per la sveglia in modalità buzzer

Definition at line 61 of file Buzzer.h.

Constructor & Destructor Documentation

◆ Buzzer()

Buzzer::Buzzer ( )

privatedefault

Costruttore di default della classe Buzzer.

Costruttore di default equivalente al costruttore trivial della seguente classe. Il seguente costruttore non sarà accessibile durante l'utilizzo della classe.

◆ ~Buzzer()

Buzzer::~Buzzer ( )

privatedefault

Distruttore della classe Buzzer.

Distruttore equivalente al distruttore trivial della seguente classe. Il seguente distruttore non sarà accessibile durante l'utilizzo della classe.

Member Function Documentation

◆ Bip()

bool Buzzer::Bip	(	const unsigned int &	t_Frequency,
		const unsigned int &	t_Duration
	)

static

Genera un'onda quadra della frequenza e durata specificati come parametri.

Questo metodo permette di generare un segnale ad onda quadra della frequenza e durata specificati come parametri. Il risultato sarà un tono udibile via PiezoBuzzer o Speaker

Precondition: L'inizializzazione della classe deve essere già stata eseguita.

Parameters

[in]	t_Frequency	La frequenza di generazione del segnale ad onda quadra
[in]	t_Duration	La durata del segnale generato

Returns: Un valore booleano per comunicare la corretta o errata esecuzione del processo di generazione del segnale ad onda quadra

Return values

true	Processo di generazione del segnale ad onda quadra eseguito correttamente
false	Errore durante il processo di generazione del segnale ad onda quadra

See also: Buzzer::m_BuzzerPin; Buzzer::m_hasBeenCalled

Definition at line 33 of file Buzzer.cpp.

◆ BipAutomated()

bool Buzzer::BipAutomated	(	const unsigned int &	t_Frequency,
		const unsigned int &	t_Duration
	)

static

AUTOMATIZZATO: Genera un'onda quadra della frequenza e durata specificati come parametri.

Questo metodo permette di generare un segnale ad onda quadra della frequenza e durata specificati come parametri. Il risultato sarà un tono udibile via PiezoBuzzer o Speaker. Il metodo presenta una automazione: verrà generato automaticamente un delay, del valore: "'t_Duration' + 'Buzzer__file::_DelayOffset'"

Precondition: L'inizializzazione della classe deve essere già stata eseguita.

Parameters

[in]	t_Frequency	La frequenza di generazione del segnale ad onda quadra
[in]	t_Duration	La durata del segnale generato

Returns: Un valore booleano per comunicare la corretta o errata esecuzione del processo di generazione del segnale ad onda quadra

Return values

true	Processo di generazione del segnale ad onda quadra eseguito correttamente
false	Errore durante il processo di generazione del segnale ad onda quadra

See also: Buzzer::m_BuzzerPin; Buzzer::m_hasBeenCalled

Definition at line 47 of file Buzzer.cpp.

◆ Init()

bool Buzzer::Init ( const int & t_BuzzerPin )

static

Metodo di inizializzazione dei componenti della classe.

Questo metodo inizializza tutti i componenti della classe, assicurando una sicura gestione della memoria. Per tale motivo, prima di poter utilizzare la classe, è necessario richiamare il suddetto metodo.

Precondition: L'inizializzazione della classe NON deve essere già stata eseguita.

Parameters

[in] t_BuzzerPin Il PIN utilizzato dal buffer per la comunicazione

Returns: Un valore booleano per comunicare la corretta o errata inizializzazione

Return values

true	Inizializzazione correttamente riuscita
false	Errore durante l'inizializzazione

Note: Questo è il primo metodo da richiamare per iniziare ad utilizzare la classe

See also: Buzzer::m_hasBeenCalled; Buzzer::m_BuzzerPin

Definition at line 15 of file Buzzer.cpp.

Member Data Documentation

◆ m_BuzzerPin

int Buzzer::m_BuzzerPin = Buzzer__file::_nopin

staticprivate

Rappresenta il PIN utilizzato dal buzzer per la comunicazione

Definition at line 94 of file Buzzer.h.

◆ m_hasBeenCalled

bool Buzzer::m_hasBeenCalled = false

staticprivate

Rappresenta il valore indicante se la classe è già stata inizializzata

Definition at line 97 of file Buzzer.h.

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

C:/RadioSvegliaGBE/PartialSourceCode/src/Buzzer/src/Buzzer.h
C:/RadioSvegliaGBE/PartialSourceCode/src/Buzzer/src/Buzzer.cpp

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Buzzer()

◆ ~Buzzer()

Member Function Documentation

◆ Bip()

◆ BipAutomated()

◆ Init()

Member Data Documentation

◆ m_BuzzerPin

◆ m_hasBeenCalled