Classe per la gestione della lettura dati via comunicazione seriale [rx, tx]. More...

#include <SerialReader.h>

Collaboration diagram for SerialReader:

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

static String	read ()
	Metodo per effettuare la lettura di dati via comunicazione seriale [rx, tx].

static String	get_buffer ()
	Permette di ottenere il valore del buffer corrente.

static const unsigned int &	get_BaudRate ()
	Permette di ottenere il valore del Baud Rate utilizzato corrente.

static const String &	get_Invalidator_asString ()
	Permette di ottenere l'invalidatore della classe --> String.

static const int &	get_Invalidator_asNumber ()
	Permette di ottenere l'invalidatore della classe --> int.

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

	~SerialReader ()=default
	Distruttore della classe SerialReader.

Static Private Member Functions
static String	read_n_format ()
	Risorsa interna per la formattazione corretta dei dati in lettura.

Static Private Attributes
static String	m_buffer

static unsigned int	m_BaudRate

static bool	m_hasBeenCalled = false

static const String	m_Invalidator_asString = SerialReader__file::_invalidvalue_asString

static const int	m_Invalidator_asNumber = SerialReader__file::_invalidvalue_asNumber

Detailed Description

Classe per la gestione della lettura dati via comunicazione seriale [rx, tx].

La seguente classe fornisce tutti i metodi necessari alla gestione della comunicazione seriale [rx, tx]

Definition at line 69 of file SerialReader.h.

Constructor & Destructor Documentation

◆ SerialReader()

SerialReader::SerialReader ( )

privatedefault

Costruttore di default della classe SerialReader.

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

◆ ~SerialReader()

SerialReader::~SerialReader ( )

privatedefault

Distruttore della classe SerialReader.

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

Member Function Documentation

◆ get_BaudRate()

const unsigned int & SerialReader::get_BaudRate ( )

inlinestatic

Permette di ottenere il valore del Baud Rate utilizzato corrente.

Questo metodo permette di ottenere come valore di ritorno il valore del Baud Rate utilizzato corrente.

See also: SerialReader::m_BaudRate

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

Returns: Il valore del Baud Rate utilizzato corrente

See also: SerialReader::m_BaudRate; SerialReader::m_hasBeenCalled

Definition at line 97 of file SerialReader.cpp.

◆ get_buffer()

String SerialReader::get_buffer ( )

inlinestatic

Permette di ottenere il valore del buffer corrente.

Questo metodo permette di ottenere come valore di ritorno il valore del buffer corrente.

See also: SerialReader::m_buffer

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

Returns: Il valore del buffer corrente

See also: SerialReader::m_buffer; SerialReader::m_hasBeenCalled

Definition at line 84 of file SerialReader.cpp.

◆ get_Invalidator_asNumber()

const int & SerialReader::get_Invalidator_asNumber ( )

inlinestatic

Permette di ottenere l'invalidatore della classe --> int.

Questo metodo permette di ottenere come valore di ritorno il valore dell'invalidatore utilizzato per questa classe. Questo valore dovrebbe essere usato in confronti con i valori di ritorno dei metodi getter per controllare l'eventuale presenza di errori.

Returns: L'invalidatore della classe SerialReader

See also: SerialReader::m_Invalidator_asNumber

Definition at line 119 of file SerialReader.cpp.

◆ get_Invalidator_asString()

const String & SerialReader::get_Invalidator_asString ( )

inlinestatic

Permette di ottenere l'invalidatore della classe --> String.

Questo metodo permette di ottenere come valore di ritorno il valore dell'invalidatore utilizzato per questa classe. Questo valore dovrebbe essere usato in confronti con i valori di ritorno dei metodi getter per controllare l'eventuale presenza di errori.

Returns: L'invalidatore della classe SerialReader

See also: SerialReader::m_Invalidator_asString

Definition at line 110 of file SerialReader.cpp.

◆ Init()

bool SerialReader::Init ( const unsigned int & t_BaudRate )

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_BaudRate Il valore del Baud Rate utilizzato

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: SerialReader::m_buffer; SerialReader::m_hasBeenCalled; SerialReader::m_BaudRate

Definition at line 15 of file SerialReader.cpp.

◆ read()

String SerialReader::read ( )

static

Metodo per effettuare la lettura di dati via comunicazione seriale [rx, tx].

Questo metodo permette di effettuare la lettura di dati via comunicazione seriale [rx, tx] Il metodo, per come è strutturato, ritorna solo e solamente quando registra il valore ASCII 0x0A, corrispondente a 'new_line'

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

Returns: Una stringa rappresentante l'informazione letta durante la comunicazione seriale

Attention: Il metodo ritorna solo alla lettura del carattere ASCII 0x0A (i.e. 'new_line'). Altromodo, rimarrà bloccato in attesa.

See also: SerialReader::m_buffer; SerialReader::m_hasBeenCalled

Definition at line 69 of file SerialReader.cpp.

Here is the call graph for this function:

◆ read_n_format()

String SerialReader::read_n_format ( )

staticprivate

Risorsa interna per la formattazione corretta dei dati in lettura.

Questo metodo fornisce una risorsa per la lettura di valori presenti sulla comunicazione seriale [rx, tx]. Durante la comunicazione, i dati vengono inviati "char x char". Questo implica la necessità di implementare manualmente una gestione per avere i dati "compattati" in un formato più comodo (i.e. 'String').

Returns: Una stringa contente il valore formattato dei dati letti

Definition at line 39 of file SerialReader.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ m_BaudRate

unsigned int SerialReader::m_BaudRate

staticprivate

Rappresenta il valore del Baud Rate utilizzato

Definition at line 107 of file SerialReader.h.

◆ m_buffer

String SerialReader::m_buffer

staticprivate

Rappresenta il valore dell'ultimo dato letto

Definition at line 103 of file SerialReader.h.

◆ m_hasBeenCalled

bool SerialReader::m_hasBeenCalled = false

staticprivate

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

Definition at line 111 of file SerialReader.h.

◆ m_Invalidator_asNumber

const int SerialReader::m_Invalidator_asNumber = SerialReader__file::_invalidvalue_asNumber

staticprivate

Rappresenta l'invalidatore della classe SerialReader

Rappresenta l'invalidatore della calsse SerialReader --> int

Definition at line 242 of file SerialReader.h.

◆ m_Invalidator_asString

const String SerialReader::m_Invalidator_asString = SerialReader__file::_invalidvalue_asString

staticprivate

Rappresenta l'invalidatore della classe SerialReader

Rappresenta l'invalidatore della classe SerialReader --> String

Definition at line 236 of file SerialReader.h.

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

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

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SerialReader()

◆ ~SerialReader()

Member Function Documentation

◆ get_BaudRate()

◆ get_buffer()

◆ get_Invalidator_asNumber()

◆ get_Invalidator_asString()

◆ Init()

◆ read()

◆ read_n_format()

Member Data Documentation

◆ m_BaudRate

◆ m_buffer

◆ m_hasBeenCalled

◆ m_Invalidator_asNumber

◆ m_Invalidator_asString