HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Devices::Concentrator::IUnit0 Struct Referenceabstract

Unit 0 interface API for HAN-FUN Concentrators. More...

#include <devices.h>

+ Inheritance diagram for HF::Devices::Concentrator::IUnit0:
+ Collaboration diagram for HF::Devices::Concentrator::IUnit0:

Public Member Functions

 IUnit0 (HF::IDevice &device)
 Constructor. More...
 
virtual HF::Core::DeviceManagement::IServerdevice_management ()=0
 Return a pointer to unit 0 device management service. More...
 
virtual HF::Core::DeviceManagement::IServerdevice_management () const =0
 Return a pointer to unit 0 device management service. More...
 
virtual HF::Core::BindManagement::IServerbind_management ()=0
 Return a pointer to unit 0 bind management service. More...
 
virtual HF::Core::BindManagement::IServerbind_management () const =0
 Return a pointer to unit 0 bind management service. More...
 
- Public Member Functions inherited from HF::Core::Unit0
 Unit0 (IDevice &device)
 Constructor. More...
 
uint8_t id () const
 Get the id number of this unit on the device. More...
 
uint16_t uid () const
 Return this profile HAN-FUN UID. More...
 
HF::Attributes::List attributes (Common::Interface itf, uint8_t pack_id, const HF::Attributes::UIDS &uids) const
 Return a list of all the attributes for a given interface, pack id and list of attributes UID's. More...
 
- Public Member Functions inherited from HF::Units::AbstractUnit
IDevicedevice () const
 Reference to the device this unit belongs to. More...
 
void send (const Protocol::Address &addr, Protocol::Message &message, Transport::Link *link)
 Create and send a new packet with the given message to the given address. More...
 
std::vector< Common::Interfaceinterfaces () const
 Return a vector containing a list of extra interfaces, other than the interfaces specified by the profile the unit implements) More...
 
void periodic (uint32_t time)
 Handle periodic processing. More...
 
- Public Member Functions inherited from HF::Units::IUnit
virtual Common::Result handle (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)=0
 Handle incoming messages from the network. More...
 
- Public Member Functions inherited from HF::IDevice::IUnit0
virtual Core::DeviceInformation::Serverdevice_info () const =0
 Return a pointer to unit 0 device information service. More...
 
virtual Core::DeviceInformation::Serverdevice_info ()=0
 Return a pointer to unit 0 device information service. More...
 
virtual Core::AttributeReporting::IServerattribute_reporting () const =0
 Return a pointer to unit 0 attribute reporting service. More...
 
virtual Core::AttributeReporting::IServerattribute_reporting ()=0
 Return a pointer to unit 0 attribute reporting service. More...
 

Additional Inherited Members

- Protected Member Functions inherited from HF::Units::AbstractUnit
 AbstractUnit (IDevice &device)
 Constructor. More...
 
void notify (const HF::Attributes::IAttribute &old_value, const HF::Attributes::IAttribute &new_value) const
 Notify the attribute reporting service that the given attribute has changed value. More...
 
- Protected Attributes inherited from HF::Units::AbstractUnit
uint8_t _id
 Unit ID used to identify a given unit in a given HAN-FUN device.
 

Detailed Description

Unit 0 interface API for HAN-FUN Concentrators.

Definition at line 607 of file devices.h.

Constructor & Destructor Documentation

◆ IUnit0()

HF::Devices::Concentrator::IUnit0::IUnit0 ( HF::IDevice device)
inline

Constructor.

Parameters
devicereference to the device this unit 0 belongs to.

Definition at line 614 of file devices.h.

614  :
616  {}
HF::Devices::Concentrator::Unit0< HF::Core::DeviceInformation::Server, ::DeviceManagement::Server, HF::Core::AttributeReporting::Server, ::BindManagement::Server > Unit0
Custom Unit0 declaration.
Definition: base.h:297
IDevice & device() const
Reference to the device this unit belongs to.
Definition: units.h:107

Member Function Documentation

◆ bind_management() [1/2]

virtual HF::Core::BindManagement::IServer* HF::Devices::Concentrator::IUnit0::bind_management ( )
pure virtual

Return a pointer to unit 0 bind management service.

Returns
pointer to unit 0 bind management service.

◆ bind_management() [2/2]

virtual HF::Core::BindManagement::IServer* HF::Devices::Concentrator::IUnit0::bind_management ( ) const
pure virtual

Return a pointer to unit 0 bind management service.

Returns
pointer to unit 0 bind management service.

◆ device_management() [1/2]

virtual HF::Core::DeviceManagement::IServer* HF::Devices::Concentrator::IUnit0::device_management ( )
pure virtual

Return a pointer to unit 0 device management service.

Returns
pointer to unit 0 device management service.

◆ device_management() [2/2]

virtual HF::Core::DeviceManagement::IServer* HF::Devices::Concentrator::IUnit0::device_management ( ) const
pure virtual

Return a pointer to unit 0 device management service.

Returns
pointer to unit 0 device management service.

The documentation for this struct was generated from the following file: