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

#include <SerialSender.h>

Collaboration diagram for SerialSender:

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

static bool	send (const char *t_toSend)
	Metodo per effettuare la scrittura di dati via comunicazione seriale [rx, tx].

static bool	send (String t_toSend)
	Metodo per effettuare la scrittura 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
	SerialSender ()=default
	Costruttore di default della classe SerialSender.

	~SerialSender ()=default
	Distruttore della classe SerialSender.

Static Private Attributes
static String	m_buffer

static unsigned int	m_BaudRate

static bool	m_hasBeenCalled = false

static const String	m_Invalidator_asString = SerialSender__file::_invalidvalue_asString

static const int	m_Invalidator_asNumber = SerialSender__file::_invalidvalue_asNumber

Detailed Description

Classe per la gestione della scrittura 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 SerialSender.h.

Constructor & Destructor Documentation

◆ SerialSender()

SerialSender::SerialSender ( )

privatedefault

Costruttore di default della classe SerialSender.

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

◆ ~SerialSender()

SerialSender::~SerialSender ( )

privatedefault

Distruttore della classe SerialSender.

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 & SerialSender::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: SerialSender::m_BaudRate

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

Returns: Il valore del Baud Rate utilizzato corrente

See also: SerialSender::m_BaudRate; SerialSender::m_hasBeenCalled

Definition at line 96 of file SerialSender.cpp.

◆ get_buffer()

String SerialSender::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: SerialSender::m_buffer

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

Returns: Il valore del buffer corrente

See also: SerialSender::m_buffer; SerialSender::m_hasBeenCalled

Definition at line 83 of file SerialSender.cpp.

◆ get_Invalidator_asNumber()

const int & SerialSender::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 SerialSender

See also: SerialSender::m_Invalidator_asNumber

Definition at line 118 of file SerialSender.cpp.

◆ get_Invalidator_asString()

const String & SerialSender::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 SerialSender

See also: SerialSender::m_Invalidator_asString

Definition at line 109 of file SerialSender.cpp.

◆ Init()

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

Definition at line 15 of file SerialSender.cpp.

◆ send() [1/2]

bool SerialSender::send ( const char * t_toSend )

static

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

Questo metodo permette di effettuare la lettura di dati via comunicazione seriale [rx, tx]

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

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

Return values

true	Trasmissione completata correttamente
false	Errore durante la trasmissione

Attention: Il metodo invierà automaticamente una 'new_line', per garantire il corretto funzionamento del ricevitore. Non aggiungere una 'new_line' supplementare manualmente

See also: SerialSender::m_buffer; SerialSender::m_hasBeenCalled

Definition at line 40 of file SerialSender.cpp.

◆ send() [2/2]

bool SerialSender::send ( String t_toSend )

static

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

Questo metodo permette di effettuare la lettura di dati via comunicazione seriale [rx, tx]

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

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

Return values

true	Trasmissione completata correttamente
false	Errore durante la trasmissione

Attention: Il metodo invierà automaticamente una 'new_line', per garantire il corretto funzionamento del ricevitore. Non aggiungere una 'new_line' supplementare manualmente

See also: SerialSender::m_buffer; SerialSender::m_hasBeenCalled

Definition at line 62 of file SerialSender.cpp.

Member Data Documentation

◆ m_BaudRate

unsigned int SerialSender::m_BaudRate

staticprivate

Rappresenta il valore del Baud Rate utilizzato

Definition at line 107 of file SerialSender.h.

◆ m_buffer

String SerialSender::m_buffer

staticprivate

Rappresenta il valore dell'ultimo dato scritto

Definition at line 103 of file SerialSender.h.

◆ m_hasBeenCalled

bool SerialSender::m_hasBeenCalled = false

staticprivate

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

Definition at line 111 of file SerialSender.h.

◆ m_Invalidator_asNumber

const int SerialSender::m_Invalidator_asNumber = SerialSender__file::_invalidvalue_asNumber

staticprivate

Rappresenta l'invalidatore della classe SerialSender

Rappresenta l'invalidatore della calsse SerialSender --> int

Definition at line 240 of file SerialSender.h.

◆ m_Invalidator_asString

const String SerialSender::m_Invalidator_asString = SerialSender__file::_invalidvalue_asString

staticprivate

Rappresenta l'invalidatore della classe SerialSender

Rappresenta l'invalidatore della classe SerialSender --> String

Definition at line 234 of file SerialSender.h.

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

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

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SerialSender()

◆ ~SerialSender()

Member Function Documentation

◆ get_BaudRate()

◆ get_buffer()

◆ get_Invalidator_asNumber()

◆ get_Invalidator_asString()

◆ Init()

◆ send() [1/2]

◆ send() [2/2]

Member Data Documentation

◆ m_BaudRate

◆ m_buffer

◆ m_hasBeenCalled

◆ m_Invalidator_asNumber

◆ m_Invalidator_asString