SerialSender.cpp

Go to the documentation of this file.

 
// Inclusione <automatica> dell'header che si sta implementando
#include "SerialSender.h"
 
// Implementazione del metodo 'Init' della categoria 'Init'
bool SerialSender::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 = SerialSender__file::_initvalue;
 
        // Avviso che la chiamata al metodo 'Init' è già stata effettuata
        m_hasBeenCalled = true;
 
        return true;
    }
    else
        return false;
}
 
// Implementazione del metodo 'send' della categoria 'Metodi'
// send (1)
bool SerialSender::send(const char* t_toSend)
{
    // Controllo se la classe è già stata inizializzata
    if (!m_hasBeenCalled)
        return false;
 
    // Salvo nella variabile 'm_buffer' il valore che sto per inviare
    m_buffer = t_toSend;
 
    // Invio i dati contenuti nel parametro 't_toSend' via comunicazione seriale [rx, tx]
    /*
    Importante è la presenza della "\nl" 'new line' ad ogni invio di dati.
    Questo è necessario per la sincronizzazione con il ricevitore. Infatti, esso riceverà i dati come singoli 'char', che poi
    provvederà a "compattare" in una stringa. L'operazione continuerà proprio fino a quando non verrà spedito come carattere, una 'new line'.
    */
    Serial.println(t_toSend);
 
    return true;
}
 
// Implementazione del metodo 'send' della categoria 'Metodi'
// send (2)
bool SerialSender::send(String t_toSend)
{
    // Controllo se la classe è già stata inizializzata
    if (!m_hasBeenCalled)
        return false;
 
    // Salvo nella variabile 'm_buffer' il valore che sto per inviare
    m_buffer = t_toSend;
 
    // Invio i dati contenuti nel parametro 't_toSend' via comunicazione seriale [rx, tx]
    /*
    Importante è la presenza della "\nl" 'new line' ad ogni invio di dati.
    Questo è necessario per la sincronizzazione con il ricevitore. Infatti, esso riceverà i dati come singoli 'char', che poi
    provvederà a "compattare" in una stringa. L'operazione continuerà proprio fino a quando non verrà spedito come carattere, una 'new line'.
    */
    Serial.println(t_toSend);
 
    return true;
}
 
// Implementazione del metodo 'get_buffer' della categoria 'Metodi'
inline String SerialSender::get_buffer()
{
    // Ritorno il valore del buffer 'm_buffer' che per�, a differenza del metodo 'read', non � stato aggiornato.
    // Contiene quindi il valore dell'ultimo dato inviato.
 
    // 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& SerialSender::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& SerialSender::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& SerialSender::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;
}
 
//////////////////////////////////////////////////////////////////////////