Classe per la gestione del sensore di temperatura ed umidità della radiosveglia. More...

#include <LocalSensor.h>

Collaboration diagram for LocalSensor:

Public Types
enum class	TemperatureUnit { CELSIUS , FAHRENHEIT }
	Enumerazione per la gestione dell'unità per la misurazione della temperatura. More...

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

static bool	Begin ()
	Metodo di avvio del sensore.

static int *const	get_SensorPin ()
	LowLevel getter per l'attributo m_SensorPin.

static int *const	get_SensorType ()
	LowLevel getter per l'attributo m_SensorType.

static DHT *const	get_Sensor ()
	LowLevel getter per l'attributo m_Sensor.

static bool	ReInit ()
	LowLevel reallocator della classe LocalSensor.

static const float	get_Temperature (const TemperatureUnit &t_Switch)
	Permette di ottenere il valore della temperatura rilevata.

static const float	get_Humidity ()
	Permette di ottenere il valore dell'umidità rilevata.

static const float &	get_Invalidator ()
	Permette di ottenere l'invalidatore della classe.

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

	~LocalSensor ()=default
	Distruttore della classe LocalSensor.

Static Private Attributes
static DHT *	m_Sensor = nullptr

static int	m_SensorPin = LocalSensor__file::_nopin

static int	m_SensorType

static float	m_Temperature

static float	m_Humidity

static const float	m_Invalidator = LocalSensor__file::_invalidvalue

Detailed Description

Classe per la gestione del sensore di temperatura ed umidità della radiosveglia.

La seguente classe fornisce tutti i metodi necessari alla gestione di un sensore di temperatura ed umidità di modello "DHT"

Definition at line 78 of file LocalSensor.h.

Member Enumeration Documentation

◆ TemperatureUnit

enum class LocalSensor::TemperatureUnit

strong

Enumerazione per la gestione dell'unità per la misurazione della temperatura.

Enumerazione per la gestione delle due unità di misura disponibili per la misurazione della temperatura. CELSIUS FAHRENHEIT

Enumerator
CELSIUS
FAHRENHEIT

Definition at line 124 of file LocalSensor.h.

Constructor & Destructor Documentation

◆ LocalSensor()

LocalSensor::LocalSensor ( )

privatedefault

Costruttore di default della classe LocalSensor.

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

◆ ~LocalSensor()

LocalSensor::~LocalSensor ( )

privatedefault

Distruttore della classe LocalSensor.

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

Member Function Documentation

◆ Begin()

bool LocalSensor::Begin ( )

static

Metodo di avvio del sensore.

Questo metodo effettua la procedura di avvio del sensore. Prima l'oggetto rappresentante deve essere stato allocato.

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

Returns: Un valore booleano per comunicare il corretto o errato avvio

Return values

true	Avvio eseguito correttamente
false	Errore durante l'avvio

Definition at line 46 of file LocalSensor.cpp.

◆ get_Humidity()

const float LocalSensor::get_Humidity ( )

static

Permette di ottenere il valore dell'umidità rilevata.

Questo metodo permette di ottenere come valore di ritorno il valore dell'umidità rilevata dal sensore.

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

Returns: Il valore dell'umidità rilevata dal sensore

See also: m_Humidity

Definition at line 124 of file LocalSensor.cpp.

◆ get_Invalidator()

const float & LocalSensor::get_Invalidator ( )

inlinestatic

Permette di ottenere l'invalidatore della classe.

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 Localsensor

See also: m_Invalidator

Definition at line 141 of file LocalSensor.cpp.

◆ get_Sensor()

DHT *const LocalSensor::get_Sensor ( )

static

LowLevel getter per l'attributo m_Sensor.

Metodo destinato a utilizzi per debugging o management manuale

Returns: Punto di accesso costante a valore modificabile per l'attributo m_Sensor

Attention: Metodo sensibile che può influenzare il corretto funzionamento del codice

See also: m_Sensor

Definition at line 76 of file LocalSensor.cpp.

◆ get_SensorPin()

int *const LocalSensor::get_SensorPin ( )

static

LowLevel getter per l'attributo m_SensorPin.

Metodo destinato a utilizzi per debugging o management manuale

Returns: Punto di accesso costante a valore modificabile per l'attributo m_SensorPin

Attention: Metodo sensibile che può influenzare il corretto funzionamento del codice

See also: m_SensorPin

Definition at line 60 of file LocalSensor.cpp.

◆ get_SensorType()

int *const LocalSensor::get_SensorType ( )

static

LowLevel getter per l'attributo m_SensorType.

Metodo destinato a utilizzi per debugging o management manuale

Returns: Punto di accesso costante a valore modificabile per l'attributo m_SensorType

Attention: Metodo sensibile che può influenzare il corretto funzionamento del codice

See also: m_SensorType

Definition at line 68 of file LocalSensor.cpp.

◆ get_Temperature()

const float LocalSensor::get_Temperature ( const TemperatureUnit & t_Switch )

static

Permette di ottenere il valore della temperatura rilevata.

Questo metodo permette di ottenere come valore di ritorno il valore della temperatura rilevata dal sensore. Fornisce anche la possibilità di specificare l'unità di misura con la quale verrà formattato il valore della temperatura.

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

Parameters

[in] t_Switch L'unità di misura per la formattazione del valore della temperatura

Returns: Il valore formattato della temperatura rilevata dal sensore

See also: m_Temperature

Definition at line 107 of file LocalSensor.cpp.

◆ Init()

bool LocalSensor::Init	(	const int &	t_SensorPin,
		const int &	t_SensorType
	)

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.

Parameters

[in]	t_SensorPin	Il PIN utilizzato dal sensore per la comunicazione
[in]	t_SensorType	Il modello del sensore, della famiglia di modello "DHT"

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

Return values

true	Inizializzazione correttamente eseguita
false	Errore durante l'inizializzazione

Note: Questo è il primo metodo da richiamare per iniziare ad utilizzare la classe

See also: m_Sensor; m_SensorPin; m_SensorType

Definition at line 15 of file LocalSensor.cpp.

◆ ReInit()

bool LocalSensor::ReInit ( )

static

LowLevel reallocator della classe LocalSensor.

Metodo destinato a utilizzi per debugging o management manuale Effettua una rinizializzazione della classe con i valori attuali contenuti negli attributi

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

Return values

true	Inizializzazione correttamente eseguita
false	Errore durante l'inizializzazione

Attention: Metodo sensibile che può influenzare il corretto funzionamento del codice

See also: m_Sensor; m_SensorPin; m_SensorType

Definition at line 83 of file LocalSensor.cpp.

Member Data Documentation

◆ m_Humidity

float LocalSensor::m_Humidity

staticprivate

Rappresenta il valore dell'umidità rilevata

Definition at line 184 of file LocalSensor.h.

◆ m_Invalidator

const float LocalSensor::m_Invalidator = LocalSensor__file::_invalidvalue

staticprivate

Rappresenta l'invalidatore della classe LocalSensor

Definition at line 387 of file LocalSensor.h.

◆ m_Sensor

DHT * LocalSensor::m_Sensor = nullptr

staticprivate

Rappresenta il sensore modello "DHT"

Definition at line 143 of file LocalSensor.h.

◆ m_SensorPin

int LocalSensor::m_SensorPin = LocalSensor__file::_nopin

staticprivate

Rappresenta il PIN utilizzato dal sensore per la comunicazione

Definition at line 152 of file LocalSensor.h.

◆ m_SensorType

int LocalSensor::m_SensorType

staticprivate

Rappresenta il modello del sensore, della famiglia di modello "DHT"

Definition at line 164 of file LocalSensor.h.

◆ m_Temperature

float LocalSensor::m_Temperature

staticprivate

Rappresenta il valore della temperatura rilevata

Definition at line 175 of file LocalSensor.h.

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

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

Public Types

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ TemperatureUnit

Constructor & Destructor Documentation

◆ LocalSensor()

◆ ~LocalSensor()

Member Function Documentation

◆ Begin()

◆ get_Humidity()

◆ get_Invalidator()

◆ get_Sensor()

◆ get_SensorPin()

◆ get_SensorType()

◆ get_Temperature()

◆ Init()

◆ ReInit()

Member Data Documentation

◆ m_Humidity

◆ m_Invalidator

◆ m_Sensor

◆ m_SensorPin

◆ m_SensorType

◆ m_Temperature