Classe di definizione dell'oggetto per la funzione 'sveglia'. More...

#include <AlarmData.h>

Collaboration diagram for AlarmData:

Public Types
enum class	AlarmState { ONLINE , OFFLINE }
	Enumerazione per la gestione dello stato della sveglia. More...

Public Member Functions
	AlarmData ()
	Costruttore di default della classe AlarmData.

	~AlarmData ()
	Distruttore della classe AlarmData.

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

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

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

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

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

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

Static Public Member Functions
static const int &	get_CoreInvalidator ()
	Permette di ottenere l'invalidatore del nucleo della classe.

Private Attributes
unsigned int	m_Hour

unsigned int	m_Minute

Clock::TimePeriod	m_Period

Clock::TimeFormat	m_Format

AlarmState	m_State

Static Private Attributes
static const int	m_CoreInvalidator = AlarmData__file::_invalidvalue

Detailed Description

Classe di definizione dell'oggetto per la funzione 'sveglia'.

La seguente classe definisce tutte le caratteristiche di una 'sveglia' e fornisce tutti i metodi necessari alla gestione di essa. E' applicabile un WRAPPER.

Definition at line 97 of file AlarmData.h.

Member Enumeration Documentation

◆ AlarmState

enum class AlarmData::AlarmState

strong

Enumerazione per la gestione dello stato della sveglia.

Enumerazione per la gestione dello stato della sveglia: ONLINE OFFLINE

Enumerator
ONLINE
OFFLINE

Definition at line 115 of file AlarmData.h.

Constructor & Destructor Documentation

◆ AlarmData()

AlarmData::AlarmData ( )

Costruttore di default della classe AlarmData.

Costruttore di default per la costruzione di un oggetto di classe AlarmData

See also: AlarmData::m_Hour; AlarmData::m_Minute; AlarmData::AlarmState

Definition at line 15 of file AlarmData.cpp.

◆ ~AlarmData()

AlarmData::~AlarmData ( )

Distruttore della classe AlarmData.

Distruttore per la distruzione di un oggetto di classe AlarmData. Prima di effettuare l'effettiva deallocazione, imposta lo stato della sveglia su 'AlarmState::OFFLINE'

See also: AlarmData::AlarmState

Definition at line 36 of file AlarmData.cpp.

Member Function Documentation

◆ Check()

bool AlarmData::Check ( )

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

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

See also: m_Hour; m_Minute; m_State

Definition at line 233 of file AlarmData.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_CoreInvalidator()

const int & AlarmData::get_CoreInvalidator ( )

inlinestatic

Permette di ottenere l'invalidatore del nucleo della classe.

Questo metodo permette di ottenere come valore di ritorno il valore dell'invalidatore utilizzato per questa classe. La particolarità sta nell'ottenimento dell'invalidatore del nucleo, che, come descritto dettagliatamente, è ben diverso dal classico invalidatore.

Returns: L'invalidatore del nucleo della classe AlarmData

See also: m_CoreInvalidator

Definition at line 333 of file AlarmData.cpp.

Here is the caller graph for this function:

◆ get_SetTime()

String AlarmData::get_SetTime ( )

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

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

Return values

String(m_CoreInvalidator) in caso di errori

See also: m_Hour; m_Minute; m_CoreInvalidator

Definition at line 164 of file AlarmData.cpp.

Here is the caller graph for this function:

◆ set_State()

bool AlarmData::set_State ( const AlarmState & t_State )

Permette di impostare lo stato della sveglia.

Questo metodo permette di impostare lo stato della sveglia. Effettua controlli su possibili operazioni ridondanti e ne segnala l'eventuale presenza

Parameters

[in] t_State Lo stato della sveglia

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

Return values

true	Nessuna operazione ridondante; assegnamento effettuato
false	Operazione ridondante o errore; nessun assegnamento effettuato; lo stato � rimasto invariato

See also: m_State

Definition at line 150 of file AlarmData.cpp.

Here is the caller graph for this function:

◆ set_Time() [1/2]

bool AlarmData::set_Time	(	const String &	t_Value,
		const Clock::TimePeriod &	t_Period = `Clock::TimePeriod::NOT_USED`
	)

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

Questo metodo permette di impostare il valore dei due attributi 'm_Hour', 'm_Minute' per il trigger della sveglia. Il valore limite per t_Minute è rappresentato dal valore dell'espressione costante AlarmData__file::_minutelimiter, il quale non subisce specializzazione Il valore limite per t_Hour può essere rappresentato da due espressioni costanti diversi, in base alla specializzazione subita I valori possono essere dati da: AlarmData__file::_12HOURS_hourlimiter, AlarmData__file::_24HOURS_hourlimiter

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]

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_Hour; m_Minute; AlarmData__file::_minutelimiter; AlarmData__file::_12HOURS_hourlimiter; AlarmData__file::_24HOURS_hourlimiter

Definition at line 98 of file AlarmData.cpp.

◆ set_Time() [2/2]

bool AlarmData::set_Time	(	const unsigned int &	t_Hour,
		const unsigned int &	t_Minute,
		const Clock::TimePeriod &	t_Period = `Clock::TimePeriod::NOT_USED`
	)

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

Questo metodo permette di impostare il valore dei due attributi 'm_Hour', 'm_Minute' per il trigger della sveglia. Il valore limite per t_Minute � rappresentato dal valore dell'espressione costante AlarmData__file::_minutelimiter, il quale non subisce specializzazione Il valore limite per t_Hour pu� essere rappresentato da due espressioni costanti diversi, in base alla specializzazione subita I valori possono essere dati da: AlarmData__file::_12HOURS_hourlimiter, AlarmData__file::_24HOURS_hourlimiter

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]

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_Hour; m_Minute; AlarmData__file::_minutelimiter; AlarmData__file::_12HOURS_hourlimiter; AlarmData__file::_24HOURS_hourlimiter

Definition at line 48 of file AlarmData.cpp.

Here is the caller graph for this function:

◆ UpdateFormat()

bool AlarmData::UpdateFormat ( )

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 o errore; nessun aggiornamento effettuato; il formato è rimasto invariato

See also: m_Format; m_CoreInvalidator

Definition at line 277 of file AlarmData.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_CoreInvalidator

const int AlarmData::m_CoreInvalidator = AlarmData__file::_invalidvalue

staticprivate

Rappresenta l'invalidatore del nucleo della classe AlarmData

Definition at line 339 of file AlarmData.h.

◆ m_Format

Clock::TimeFormat AlarmData::m_Format

private

Rappresenta il formato dell'ora dal punto di vista della classe AlarmData

See also: Clock::TimeFormat

Definition at line 149 of file AlarmData.h.

◆ m_Hour

unsigned int AlarmData::m_Hour

private

Rappresenta il valore dell'ora 'hh' per il trigger della sveglia

Definition at line 130 of file AlarmData.h.

◆ m_Minute

unsigned int AlarmData::m_Minute

private

Rappresenta il valore dell'ora 'mm' per il trigger della sveglia

Definition at line 139 of file AlarmData.h.

◆ m_Period

Clock::TimePeriod AlarmData::m_Period

private

Rappresenta il periodo dell'ora

See also: Clock::TimePeriod

Definition at line 144 of file AlarmData.h.

◆ m_State

AlarmState AlarmData::m_State

private

Rappresenta lo stato della sveglia

See also: AlarmData::AlarmState

Definition at line 154 of file AlarmData.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ AlarmState

Constructor & Destructor Documentation

◆ AlarmData()

◆ ~AlarmData()

Member Function Documentation

◆ Check()

◆ get_CoreInvalidator()

◆ get_SetTime()

◆ set_State()

◆ set_Time() [1/2]

◆ set_Time() [2/2]

◆ UpdateFormat()

Member Data Documentation

◆ m_CoreInvalidator

◆ m_Format

◆ m_Hour

◆ m_Minute

◆ m_Period

◆ m_State