This module contains the classes that define and implement the Time service API. More...

Collaboration diagram for Time service:

Data Structures
struct	HF::Core::Time::Value
	Helper class to handle the Time attribute for the Time service. More...

struct	HF::Core::Time::Date
	Helper class to parse the time value into a human readable string. More...

struct	HF::Core::Time::Base
	Time Service : Parent. More...

class	HF::Core::Time::Server
	Time Service : Server side implementation. More...

struct	HF::Core::Time::Client
	Time Service : Client side implementation. More...

Enumerations
enum	HF::Core::Time::Attributes { HF::Core::Time::TIME_ATTR = 1 }
	Attributes. More...

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

uint32_t	HF::Core::Time::convert (const Date &date)
	Convert the date given by `date` to the corresponding time value. More...

Date	HF::Core::Time::convert (uint32_t time)
	Split the time given by `value` to the year, month, day, hour, minute and second values. More...

Date	HF::Core::Time::convert (const Value &value)
	Split the time given by `value` to the year, month, day, hour, minute and second values. More...

HF::Attributes::IAttribute *	HF::Core::Time::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given `uid`. (HF::Interfaces::Time::Server *,uint8_t) More...

std::ostream &	operator<< (std::ostream &stream, const HF::Core::Time::Attributes attribute)
	Convert the given `attribute` into a string and write it to the given `stream`. More...

std::ostream &	operator<< (std::ostream &stream, const HF::Core::Time::Date &date)
	Convert the given `attribute` into a string and write it to the given `stream`. More...

Detailed Description

This module contains the classes that define and implement the Time service API.

Enumeration Type Documentation

◆ Attributes

enum HF::Core::Time::Attributes

Attributes.

Enumerator
TIME_ATTR	Time attribute UID.

Definition at line 63 of file time.h.

          {
             TIME_ATTR     = 1, 
             __LAST_ATTR__ = TIME_ATTR
          } Attributes;

Function Documentation

◆ convert() [1/3]

uint32_t HF::Core::Time::convert ( const Date & date )

Convert the date given by date to the corresponding time value.

Parameters

[in] date reference to the date to convert from.

Returns: the time that corresponds to the given date or Value::INVALID in case of error.

◆ convert() [2/3]

Date HF::Core::Time::convert ( uint32_t time )

Split the time given by value to the year, month, day, hour, minute and second values.

Parameters

[in] time value to convert.

Returns: a Date structure containing the time value split into the proper fields.

◆ convert() [3/3]

Date HF::Core::Time::convert ( const Value & value )

Split the time given by value to the year, month, day, hour, minute and second values.

Parameters

[in] value reference to the attribute containing the time value to convert.

Returns: a Date structure containing the time value split into the proper fields.

◆ create_attribute() [1/2]

HF::Attributes::IAttribute* HF::Core::create_attribute	(	Time::Server *	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::Time::create_attribute ( uint8_t uid )

inline

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

See also: HF::Core::create_attribute (HF::Core::Time::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.

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.