Weekly Scheduling

This module contains the classes that implement the Weekly Scheduling service. More...

Collaboration diagram for Weekly Scheduling:

Data Structures
struct	HF::Core::Scheduling::Weekly::Day
	Specific part for the Weekly Scheduler of the HF::Scheduling::Entry. More...
struct	HF::Core::Scheduling::Weekly::MaximumNumberOfEntries
	Helper class to handle the Maximum Number Of Entries attribute for the Weekly Scheduling service. More...
struct	HF::Core::Scheduling::Weekly::NumberOfEntries
	Helper class to handle the Number Of Entries attribute for the Weekly Scheduling service. More...
struct	HF::Core::Scheduling::Weekly::Status
	Helper class to handle the Status attribute for the Weekly Scheduling service. More...
struct	HF::Core::Scheduling::Weekly::IClient
	Weekly Scheduling Service : Client side implementation. More...
struct	HF::Core::Scheduling::Weekly::Client
	Scheduling Service : Client side implementation. More...
struct	HF::Core::Scheduling::Weekly::IServer
	Scheduling Service : Server side implementation. More...
struct	HF::Core::Scheduling::Weekly::Server< _Entries >
	Scheduling Service : Server side implementation. More...

Typedefs
typedef Scheduling::Entry< Day >	HF::Core::Scheduling::Weekly::Entry
	Specific part for the Weekly Scheduler of the HF::Scheduling::Entry.
typedef Scheduling::GetEntryResponse< Day >	HF::Core::Scheduling::Weekly::GetEntryResponse
	Specific part for the Weekly Scheduler of the HF::Scheduling::GetEntryResonse.
typedef Server< Entries< Day > >	HF::Core::Scheduling::Weekly::DefaultServer
	Weekly Scheduling Service : Server side with default persistence implementation.

Enumerations
enum	HF::Core::Scheduling::Weekly::Days
	Day of the Week enumeration.

Functions
HF::Attributes::IAttribute *	HF::Core::create_attribute (Scheduling::Weekly::IServer *server, uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. More...
HF::Attributes::IAttribute *	HF::Core::Scheduling::Weekly::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Weekly::IServer *,uint8_t) More...

Detailed Description

This module contains the classes that implement the Weekly Scheduling service.

Function Documentation

create_attribute() [1/2]

HF::Attributes::IAttribute* HF::Core::create_attribute	(	Scheduling::Weekly::IServer *	server,
		uint8_t	uid
	)

Create an attribute object that can hold the attribute with the given uid.

If server is not equal to nullptr then initialize it with the current value.

Parameters

[in]	server	pointer to the object to read the current value from.
[in]	uid	attribute's UID to create the attribute object for.

Returns

pointer to an attribute object or nullptr if the attribute UID does not exist.

create_attribute() [2/2]

HF::Attributes::IAttribute* HF::Core::Scheduling::Weekly::create_attribute ( uint8_t  uid )

inline

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Weekly::IServer *,uint8_t)

See also

HF::Core::create_attribute (HF::Core::Scheduling::Weekly::IServer *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Returns

pointer to an attribute object or nullptr if the attribute UID does not exist.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Weekly::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Time::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SUOTA::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::RSSI::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::GroupTable::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Event::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceInformation::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BindManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BatchProgramManagement::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also

HF::Interfaces::create_attribute (HF::Interfaces::SimpleHumidity::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Returns

pointer to an attribute object or nullptr if the attribute UID does not exist.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Weekly::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Time::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SUOTA::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::RSSI::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::GroupTable::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Event::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceInformation::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BindManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BatchProgramManagement::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also

HF::Interfaces::create_attribute (HF::Interfaces::SimpleTemperature::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Return values

pointer	to an attribute object
<tt>nullptr</tt>	if the attribute UID does not exist.

Definition at line 108 of file simple_humidity.h.

         {
            return Interfaces::create_attribute(static_cast<SimpleHumidity::Server *>(nullptr),
                                                uid);
         }