HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
Attribute Reporting

This module contains the classes that implement the Attribute Reporting service. More...

+ Collaboration diagram for Attribute Reporting:

Modules

 Common
 This module contains the common definitions for the Attribute Reporting service implementation.
 
 Event
 This module contains the class that implement the support for the event rules in the Attribute Reporting service.
 
 Periodic
 This module contains the class that implement the support for the periodic rules in the Attribute Reporting service.
 
 Reports
 This module contains the classes that implement the messages used in the Attribute Reporting service implementation.
 

Data Structures

struct  HF::Core::AttributeReporting::Client
 Attribute Reporting - Client Role. More...
 
struct  HF::Core::AttributeReporting::AbstractClient
 Helper class for using the Attribute Reporting service. More...
 
struct  HF::Core::AttributeReporting::IServer
 Attribute Reporting - Server Role. More...
 
struct  HF::Core::AttributeReporting::Server
 Attribute Reporting - Server Role. More...
 

Functions

HF::Attributes::IAttributeHF::Core::create_attribute (HF::Core::AttributeReporting::IServer *server, uint8_t uid)
 Create an attribute object that can hold the attribute with the given uid. More...
 
std::ostream & operator<< (std::ostream &stream, const HF::Core::AttributeReporting::CMD command)
 Convert the given command into a string and write it to the given stream. More...
 
std::ostream & operator<< (std::ostream &stream, const HF::Core::AttributeReporting::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 implement the Attribute Reporting service.

Function Documentation

◆ create_attribute()

HF::Attributes::IAttribute* HF::Core::create_attribute ( HF::Core::AttributeReporting::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]serverpointer to the object to read the current value from.
[in]uidattribute's UID to create the attribute object for.
Returns
pointer to an attribute object or nullptr if the attribute UID does not exist.

Referenced by HF::Core::AttributeReporting::IServer::attribute().

+ Here is the caller graph for this function:

◆ operator<<() [1/2]

std::ostream& operator<< ( std::ostream &  stream,
const HF::Core::AttributeReporting::CMD  command 
)

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

Parameters
[in]streamout stream to write the string to.
[in]commandrole value to convert to a string.
Returns
stream

◆ operator<<() [2/2]

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

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

Parameters
[in]streamout stream to write the string to.
[in]attributeattribute value to convert to a string.
Returns
stream