Classe per la gestione della sveglia integrata digitale. More...

#include <Alarm.h>

Collaboration diagram for Alarm:

Static Public Member Functions
static bool	Init ()
	Metodo di inizializzazione dei componenti della classe.

static bool	set_Time (const unsigned int &t_Hour, const unsigned int &t_Minute)
	Permette di impostare il valore dell'ora per il trigger della sveglia.

static bool	set_Time (const unsigned int &t_Hour, const unsigned int &t_Minute, const Clock::TimePeriod &t_Period)
	Permette di impostare il valore dell'ora per il trigger della sveglia.

static bool	set_Time (const String &t_Value)
	Permette di impostare il valore dell'ora per il trigger della sveglia.

static bool	set_Time (const String &t_Value, const Clock::TimePeriod &t_Period)
	Permette di impostare il valore dell'ora per il trigger della sveglia.

static bool	set_State (const AlarmData::AlarmState &t_State)
	Permette di impostare lo stato della sveglia.

static AlarmData *const	get_Alarm ()
	LowLevel getter per l'attributo m_Alarm.

static String	get_SetTime ()
	Restituisce il valore dell'ora impostata per il trigger della sveglia.

static bool	Check ()
	Restituisce se la sveglia è in trigger al momento della chiamata del metodo stesso oppure no.

static bool	UpdateFormat ()
	Aggiorna il formato dell'ora corrente dal punto di vista di AlarmData.

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

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

	~Alarm ()=default
	Distruttore della classe Alarm.

Static Private Attributes
static AlarmData *	m_Alarm

static const int	m_Invalidator = Alarm__file::_invalidvalue

Detailed Description

Classe per la gestione della sveglia integrata digitale.

La seguente classe fornisce tutti i metodi necessari alla gestione di una sveglia

Definition at line 76 of file Alarm.h.

Constructor & Destructor Documentation

◆ Alarm()

Alarm::Alarm ( )

privatedefault

Costruttore di default della classe Alarm.

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

◆ ~Alarm()

Alarm::~Alarm ( )

privatedefault

Distruttore della classe Alarm.

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

Member Function Documentation

◆ Check()

bool Alarm::Check ( )

static

Restituisce se la sveglia è in trigger al momento della chiamata del metodo stesso oppure no.

Questo metodo permette di ottenere come valore di ritorno il valore informativo riguardo il trigger della sveglia

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

Returns: Il valore informativo riguardo il trigger della sveglia

Return values

true	La sveglia è in trigger al momento della chiamata del metodo
false	La sveglia non è in trigger al momento della chiamata del metodo; errore durante l'operazione di richiesta del valore informativo riguardo il trigger della sveglia

See also: m_Alarm

Definition at line 139 of file Alarm.cpp.

Here is the call graph for this function:

◆ get_Alarm()

AlarmData *const Alarm::get_Alarm ( )

static

LowLevel getter per l'attributo m_Alarm.

Metodo destinato a utilizzi per debugging o management manuale

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

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

See also: m_Alarm

Definition at line 113 of file Alarm.cpp.

◆ get_Invalidator()

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

See also: m_Invalidator

◆ get_SetTime()

String Alarm::get_SetTime ( )

static

Restituisce il valore dell'ora impostata per il trigger della sveglia.

Questo metodo permette di ottenere come valore di ritorno il valore dell'ora impostata per il trigger della sveglia

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

Returns: Il valore dell'ora impostata per il trigger della sveglia

Return values

String(m_Invalidator) in caso di String(AlarmData::m_CoreInvalidator) in caso di errori

See also: m_Alarm; m_Invalidator

Definition at line 120 of file Alarm.cpp.

Here is the call graph for this function:

◆ Init()

bool Alarm::Init ( )

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.

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_Alarm

Definition at line 15 of file Alarm.cpp.

◆ set_State()

bool Alarm::set_State ( const AlarmData::AlarmState & t_State )

static

Permette di impostare lo stato della sveglia.

Questo metodo permette di impostare lo stato della sveglia.

Parameters

[in] t_State Lo stato della sveglia

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

Returns: Un valore booleano per indicare eventuali operazioni ridondanti, e quindi non considerate, oppure errori

Return values

true	Nessuna operazione ridondante e nessun errore; operazione effettuata
false	Operazione ridondante o errore; nessun operazione effettuata

See also: m_Alarm; AlarmData::AlarmState

Definition at line 99 of file Alarm.cpp.

Here is the call graph for this function:

◆ set_Time() [1/4]

bool Alarm::set_Time ( const String & t_Value )

static

Permette di impostare il valore dell'ora per il trigger della sveglia.

Questo metodo permette di impostare il valore dell'ora per il trigger della sveglia

Parameters

[in] t_Value Il valore dell'ora per il trigger della sveglia. Il formato accettato è una stringa del formato: 'hh:mm period (facoltativo)'

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

Warning: Il formato della stringa è: "hh:mm period (facoltativo)". La maggior parte di altri formati verranno scartati, ma alcuni potrebbero causare comportamenti e risposte indefinite da parte del programma.

Returns: Un valore booleano per indicare la corretta esecuzione del processo di impostazione dell'ora per il trigger della sveglia

Return values

true	Processo di impostazione dell'ora per il trigger della sveglia eseguito correttamente (parametri corretti)
false	Errore durante il processo di impostazione dell'ora per il trigger della sveglia (parametri errati)

See also: m_Alarm

Definition at line 70 of file Alarm.cpp.

Here is the call graph for this function:

◆ set_Time() [2/4]

bool Alarm::set_Time	(	const String &	t_Value,
		const Clock::TimePeriod &	t_Period
	)

static

Permette di impostare il valore dell'ora per il trigger della sveglia.

Questo metodo permette di impostare il valore dell'ora per il trigger della sveglia

Parameters

[in]	t_Value	Il valore dell'ora per il trigger della sveglia. Il formato accettato è una stringa del formato: 'hh:mm period (facoltativo)'
[in]	t_Period	Il periodo dell'ora 'AM [12h] / PM [12h] / NOT_USED [24h]

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

Warning: Il formato della stringa è: "hh:mm period (facoltativo)". La maggior parte di altri formati verranno scartati, ma alcuni potrebbero causare comportamenti e risposte indefinite da parte del programma.

Returns: Un valore booleano per indicare la corretta esecuzione del processo di impostazione dell'ora per il trigger della sveglia

Return values

true	Processo di impostazione dell'ora per il trigger della sveglia eseguito correttamente (parametri corretti)
false	Errore durante il processo di impostazione dell'ora per il trigger della sveglia (parametri errati)

See also: m_Alarm; Clock::TimePeriod

Definition at line 85 of file Alarm.cpp.

Here is the call graph for this function:

◆ set_Time() [3/4]

bool Alarm::set_Time	(	const unsigned int &	t_Hour,
		const unsigned int &	t_Minute
	)

static

Permette di impostare il valore dell'ora per il trigger della sveglia.

Questo metodo permette di impostare il valore dell'ora per il trigger della sveglia

Parameters

[in]	t_Hour	Il valore dell'ora 'hh' per il trigger della sveglia
[in]	t_Minute	Il valore dell'ora 'mm' per il trigger della sveglia

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

Returns: Un valore booleano per indicare la corretta esecuzione del processo di impostazione dell'ora per il trigger della sveglia

Return values

true	Processo di impostazione dell'ora per il trigger della sveglia eseguito correttamente (parametri corretti)
false	Errore durante il processo di impostazione dell'ora per il trigger della sveglia (parametri errati)

See also: m_Alarm

Definition at line 40 of file Alarm.cpp.

Here is the call graph for this function:

◆ set_Time() [4/4]

bool Alarm::set_Time	(	const unsigned int &	t_Hour,
		const unsigned int &	t_Minute,
		const Clock::TimePeriod &	t_Period
	)

static

Permette di impostare il valore dell'ora per il trigger della sveglia.

Questo metodo permette di impostare il valore dell'ora per il trigger della sveglia

Parameters

[in]	t_Hour	Il valore dell'ora 'hh' per il trigger della sveglia
[in]	t_Minute	Il valore dell'ora 'mm' per il trigger della sveglia
[in]	t_Period	Il periodo dell'ora 'AM [12h] / PM [12h] / NOT_USED [24h]

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

Returns: Un valore booleano per indicare la corretta esecuzione del processo di impostazione dell'ora per il trigger della sveglia

Return values

true	Processo di impostazione dell'ora per il trigger della sveglia eseguito correttamente (parametri corretti)
false	Errore durante il processo di impostazione dell'ora per il trigger della sveglia (parametri errati)

See also: m_Alarm; Clock::TimePeriod

Definition at line 55 of file Alarm.cpp.

Here is the call graph for this function:

◆ UpdateFormat()

bool Alarm::UpdateFormat ( )

static

Aggiorna il formato dell'ora corrente dal punto di vista di AlarmData.

Questo metodo aggiorna il formato dell'ora corrente dal punto di vista di AlarmData efefttuando le opportune conversioni tra formati d'ora differenti

Returns: Un valore booleano per indicare eventuali operazioni ridondanti, e quindi non considerate, oppure errori

Return values

true	Nessuna operazione ridondante; aggiornamento effettuato
false	Operazione ridondante; nessun aggiornamento effettuato; errore durante l'operazione di aggiornamento

See also: m_Alarm

Definition at line 153 of file Alarm.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_Alarm

AlarmData * Alarm::m_Alarm

staticprivate

Rappresenta la sveglia

Definition at line 121 of file Alarm.h.

◆ m_Invalidator

const int Alarm::m_Invalidator = Alarm__file::_invalidvalue

staticprivate

Rappresenta l'invalidatore della classe Alarm

Definition at line 369 of file Alarm.h.

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

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

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Alarm()

◆ ~Alarm()

Member Function Documentation

◆ Check()

◆ get_Alarm()

◆ get_Invalidator()

◆ get_SetTime()

◆ Init()

◆ set_State()

◆ set_Time() [1/4]

◆ set_Time() [2/4]

◆ set_Time() [3/4]

◆ set_Time() [4/4]

◆ UpdateFormat()

Member Data Documentation

◆ m_Alarm

◆ m_Invalidator