RSSI interface

This module contains the classes that define and implement the RSSI interface API. More...

Collaboration diagram for RSSI interface:

Data Structures
struct	HF::Core::RSSI::Value
	Helper class to handle the RSSI attribute for the RSSI interface. More...
struct	HF::Core::RSSI::Base
	RSSI Interfaces::Interface : Parent. More...
class	HF::Core::RSSI::Server
	RSSI Interfaces::Interface : Server side implementation. More...
struct	HF::Core::RSSI::Client
	RSSI Interfaces::Interface : Client side implementation. More...

Enumerations
enum	HF::Core::RSSI::Attributes { HF::Core::RSSI::RSSI_ATTR = 1 }
	Attributes. More...

Functions
HF::Attributes::IAttribute *	HF::Core::create_attribute (RSSI::Server *server, uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. More...
HF::Attributes::IAttribute *	HF::Core::RSSI::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::RSSI::Server *,uint8_t) More...
std::ostream &	operator<< (std::ostream &stream, const HF::Core::RSSI::Attributes attribute)
	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 RSSI interface API.

Enumeration Type Documentation

Attributes

enum HF::Core::RSSI::Attributes

Attributes.

Enumerator
RSSI_ATTR	RSSI attribute UID.

Definition at line 63 of file rssi.h.

         {
            RSSI_ATTR     = 1, 
            __LAST_ATTR__ = RSSI_ATTR
         } Attributes;

Function Documentation

create_attribute() [1/2]

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

inline

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

See also

HF::Core::create_attribute (HF::Core::RSSI::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::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::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);
         }

operator<<()

std::ostream& operator<<	(	std::ostream &	stream,
		const HF::Core::RSSI::Attributes	attribute
	)

Convert the given attribute into a string and write it to the given stream.

Parameters

[in]	stream	out stream to write the string to.
[in]	attribute	attribute value to convert to a string.

Returns

stream