SerialReader.cpp

Go to the documentation of this file.

 
 // Inclusione <automatica> dell'header che si sta implementando
#include "SerialReader.h"
 
// Implementazione del metodo 'Init' della categoria 'Init'
bool SerialReader::Init(const unsigned int& t_BaudRate)
{
    // Controllo che la classe non sia già stata inizializzata
    if (!m_hasBeenCalled)
    {
        // Inizializzo la comunicazione seriale attraverso il metodo 'begin' di gestione delle porte seriali
        Serial.begin(t_BaudRate);
 
        // Imposto il valore di 'm_BaudRate' al valore del parametro 't_BaudRate'
        m_BaudRate = t_BaudRate;
 
        // Imposto il valore di 'm_buffer' al valore della constexpr '_initvalue'
        m_buffer = SerialReader__file::_initvalue;
 
        // Avviso che la chiamata al metodo 'Init' è già stata effettuata
        m_hasBeenCalled = true;
 
        return true;
    }
    else
        return false;
}
 
// Implementazione del metodo 'read_n_format' della categoria 'Risorse Interne'
String SerialReader::read_n_format()
{
    // Inizializzazione variabili di gestione dell'input
    char l_input = NULL;
    String l_input_linker = "";
 
    // Ripeti fintantochè l'input != NEW_LINE
    while (l_input != 0x0A)
    {
        // Controllo che la porta seriale sia disponibile
        if (Serial.available() > 0)
        {
            // Leggo valore
            l_input = Serial.read();
 
            // Se l'input è qualsiasi carattere (eccetto NEW_LINE (ASCII --> 0x0A))
            if (l_input != 0x0A)
            {
                // Concateno
                l_input_linker += String(l_input);
            }
        }
    }
 
    // Alla lettura di NEW_LINE, significa che l'input � terminato
    // Esco dal metodo, ritornando la stringa contentente il mio intero input
    return l_input_linker;
}
 
// Implementazione del metodo 'read' della categoria 'Metodi'
String SerialReader::read()
{
    // Controllo se la classe è già stata inizializzata
    if (!m_hasBeenCalled)
        return m_Invalidator_asString;
 
    // Salvo nella variabile 'm_buffer' il valore appena letto attraverso la chiamata del metodo 'read_n_format' della classe "SerialReader"
    m_buffer = read_n_format();
 
    // Ritorno il valore del buffer 'm_buffer' appena aggiornato
    // Ritorno il valore come copia per consentire all'utente qualsiasi modifica senza modificare l'attributo originale della classe
    return m_buffer;
}
 
// Implementazione del metodo 'get_buffer' della categoria 'Metodi'
inline String SerialReader::get_buffer()
{
    // Ritorno il valore del buffer 'm_buffer' che per�, a differenza del metodo 'read', non � stato aggiornato.
    // Contiene quindi il valore dell'ultima lettura effettuata.
 
    // Controllo se la classe è già stata inizializzata
    if (!m_hasBeenCalled)
        return m_Invalidator_asString;
 
    return m_buffer;
}
 
// Implementazione del metodo 'get_BaudRate' della categoria 'Metodi'
inline const unsigned int& SerialReader::get_BaudRate()
{
    // Ritorno il valore di 'm_BaudRate'
 
    // Controllo se la classe è già stata inizializzata
    if (!m_hasBeenCalled)
        return m_Invalidator_asNumber;
    
    return m_BaudRate;
}
 
// Implementazione del metodo 'get_Invalidator_asString' della categoria 'getter -> Invalidator'
/*La specificazione 'inline' rappresenta una grossa ottimizzazione!!*/
inline const String& SerialReader::get_Invalidator_asString()
{
    // Ritorno il valore dell'attributo 'm_Invalidator_asString'. Per evitare la copia durante la fase di ritorno, ritorno l'attributo
    // originale [referenza --> reference '&']. L'attributo è già costante, questo evita modifiche non autorizzate.
    return m_Invalidator_asString;
}
 
// Implementazione del metodo 'get_Invalidator_asNumber' della categoria 'getter -> Invalidator'
/*La specificazione 'inline' rappresenta una grossa ottimizzazione!!*/
inline const int& SerialReader::get_Invalidator_asNumber()
{
    // Ritorno il valore dell'attributo 'm_Invalidator_asNumber'. Per evitare la copia durante la fase di ritorno, ritorno l'attributo
    // originale [referenza --> reference '&']. L'attributo è già costante, questo evita modifiche non autorizzate.
    return m_Invalidator_asNumber;
}
 
//////////////////////////////////////////////////////////////////////////