Buzzer.h

Go to the documentation of this file.

#pragma once
 
#pragma region INCLUSIONS
// nothing
#pragma endregion INCLUSIONS
 
// Namespace di protezione dalle inclusioni multiple con nominazione uguale
/*
I valori constexpr, come spiegato appena sopra, equivalgono alla direttiva '#define'. Questo pu� creare problemi nel momento in cui un singolo file viene incluso
in una gerarchia di molti pi� file, dove si potrebbe riscontrare la presenza di constexpr appartenenti a file diversi ma con gli stessi nomi! Questa ripetitivit� dei nomi deriva
dagli standard di nominazione. Per evitare, quindi, conflitti di multipla definizione, andremo ad utilizzare un 'namespace', che, come dice il nome, fornisce uno SPAZIO per i NOMI del nostro
file in cui il 'namespace' � stato dichiarato ed implementato.
Mantieniamo comunque la specificazione 'static', per evitare errori di linker in caso di inclusioni multiple di questa unit� di traslazione [file].
*/
namespace Buzzer__file
{
    // Espressione costante (equivalente della direttiva '#define') per la definizione di un valore di "non-pin".
    // Questo valore rappresenta lo stato delle variabili contenenti valori relativi ai PIN prima dell'inizializzazione.
    /*Lasciare variabili PIN senza inizializzazione potrebbe causare risultati indefiniti.*/
    static constexpr auto _nopin = -1;
 
    static constexpr auto _DelayOffset = 500;
}
 
class Buzzer
{
    /*Blocco trivial*/
    /*
    Stiamo trattando una classe interamente statica. Per la definizione di staticità, descritta successivamente, questa classe fungerà solamente
    da "contenitore astratto" per organizzare più logicamente i dati. In verità, tutto risiederà principalmente nel Data Segment, quindi sarà
    globale, ma statico (anche questo descritto successivamente).
    Questa staticità implica la NON necessità di creare istanze di questa classe, che risulterebbero totalmente inutili dato che tutti gli attributi
    e i metodi esistono nell'ambito globale.
    Per evitare, quindi, inutili istanziamenti, verranno bloccati il costruttore trivial (di default generato dal compilatore) e il distruttore, reso
    inutile dalla non-istanziabilità della classe stessa.
    */
private:
    // Blocco attraverso privatizzazione del costruttore trivial
    Buzzer() = default;
    // Blocco attraverso privatizzazione del distruttore trivial
    ~Buzzer() = default;
 
    /*Attributi*/
private:
    static int m_BuzzerPin;
 
    static bool m_hasBeenCalled;
 
    /*Init*/
public:
    static bool Init(const int& t_BuzzerPin);
 
    /*Metodi*/
    static bool Bip(const unsigned int& t_Frequency, const unsigned int& t_Duration);
 
    /*Metodi di Automazione*/
    static bool BipAutomated(const unsigned int& t_Frequency, const unsigned int& t_Duration);
};
 
// Dichiarazione delle variabili GLOBALI STATICHE 
// Risiederanno nel Data Segment
/*
Essendo statiche in classe, tutti gli attributi non sono altro che variabili GLOBALI STATICHE.
Per questo è richiesta la dichiarazione globale. Non è necessario specificare 'static' essendo già stato specificato nella dichiarazione degli
attributi nella classe stessa.
*/
int Buzzer::m_BuzzerPin = Buzzer__file::_nopin;
bool Buzzer::m_hasBeenCalled = false;