Helper template class used to define custom Unit 0 for devices. More...

#include <core.h>

Inheritance diagram for HF::Unit0< Base, ITF >:

Collaboration diagram for HF::Unit0< Base, ITF >:

Public Types
enum	Inferface : uint8_t { DEV_INFO = 0, DEV_MGT, ATTR_RPT, BIND_MGT }
	Core Services indexs. More...

Public Member Functions
	Unit0 (HF::IDevice &device)
	Constructor. More...

DeviceInfo *	device_info () const
	Device Information service. More...

DeviceInfo *	device_info ()
	Device Information service. More...

DeviceMgt *	device_management () const
	Device Management service. More...

DeviceMgt *	device_management ()
	Device Management service. More...

AttrReporting *	attribute_reporting () const
	Attribute Reporting service. More...

AttrReporting *	attribute_reporting ()
	Attribute Reporting service. More...

Common::Result	handle (HF::Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. 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...

void	periodic (uint32_t time)
	Handle periodic processing. More...

Public Member Functions inherited from Base
void	receive (HF::Protocol::Packet &packet, HF::Common::ByteArray &payload, uint16_t offset)
	Callback to deliver a packet received from the transport layer. More...

bool	has_bind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Check if bind exists. More...

uint8_t	bind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Create a new bind entry. More...

bool	unbind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Remove the binding entry for the given devices. More...

Public Member Functions inherited from HF::Devices::Concentrator::Abstract< CoreServices >
CoreServices *	unit0 () const
	Get the unit 0 used by this concentrator device. More...

Public Member Functions inherited from HF::Devices::Concentrator::AbstractBase
uint16_t	address () const
	Return the device address on the HAN-FUN network, when the device is registered, or `HF_BROADCAST_ADDR` otherwise. More...

void	connected (HF::Transport::Link *link)
	Callback to report that a new transport `link` was been created to a remote device. More...

void	disconnected (HF::Transport::Link *link)
	Callback to the report that the given transport `link` no longer is valid and MUST not be used to send messages to the corresponding end-point. More...

Public Member Functions inherited from HF::Devices::AbstractDevice
const IUnits &	units () const
	Return the list of units registered in this device. More...

void	add (Units::IUnit *unit)
	Add unit to devices unit lists. More...

void	remove (Units::IUnit *unit)
	Remove unit from device's unit list. More...

Units::IUnit *	unit (uint8_t id) const
	Return pointer to the unit with the given id. More...

void	send (Protocol::Packet &packet)
	Send given `packet` into the HAN-FUN network. More...

void	periodic (uint32_t time)
	Handle periodic processing. More...

Events
Public Member Functions inherited from HF::Interfaces::Container< Base, Proxy< ITF, Base >... >
	Container (Base &base)
	Constructor. More...

Common::Result	handle (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

void	attributes (HF::Attributes::List &attr_list, 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...

std::vector< Common::Interface >	interfaces () const
	Return the list of interfaces present in the wrapper. More...

const std::tuple_element< N, interfaces_t >::type::base *	get () const
	Retrieve a pointer to the N optional interface implemented by this unit. More...

Additional Inherited Members
Protected Member Functions inherited from HF::Devices::Concentrator::AbstractBase
HF::Transport::Link *	link (uint16_t addr) const
	Return the link that can be used to send a packet to the device with the given address. More...

virtual void	route_packet (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Route the given packet to the corresponding device. More...

Protected Member Functions inherited from HF::Devices::AbstractDevice
virtual bool	to_local (const Protocol::Packet &packet) const
	Check if the given packet is for this device. More...

bool	from_local (const Protocol::Packet &packet) const
	Check if the given packet is from the local device. More...

bool	from_remote (const Protocol::Packet &packet)
	Check if the given packet is from the a remote device. More...

bool	is_registered ()
	Check if the device has a valid, i.e. More...

Protected Member Functions inherited from HF::Interfaces::Container< Base, Proxy< ITF, Base >... >
void	for_each (std::function< void(HF::Interface &)> func) const
	Call the given function for all the interfaces. More...

void	for_each (std::function< void(HF::Interface &)> func)
	Call the given function for all the interfaces. More...

void	for_each (std::function< void(HF::Interface &)> func) const
	Helper template function to implement the HF::Units::Unit::for_each functionality. More...

void	for_each (std::function< void(HF::Interface &)> func) const
	Helper template function to implement the HF::Units::Unit::for_each functionality. More...

HF::Interface *	find (uint16_t itf_uid) const
	Find the interface with the given UID. More...

HF::Interface *	find (uint16_t itf_uid) const
	Final template instantiation that finds the wrapped interface with the given UID. More...

void	attributes_itf (HF::Attributes::List &attrs, Common::Interface itf, uint8_t pack_id, const HF::Attributes::UIDS &uids) const
	Helper function used to provide HF::Units::Unit::attributes functionality. More...

void	attributes_itf (HF::Attributes::List &attrs, Common::Interface itf, uint8_t pack_id, const HF::Attributes::UIDS &uids) const
	Helper function used to provide HF::Units::Unit::attributes functionality. More...

Protected Attributes inherited from HF::Devices::Concentrator::AbstractBase
Common::SimpleList< Transport::Link * >	_links
	List of links present in this concentrator.

Protected Attributes inherited from HF::Devices::AbstractDevice
uint8_t	next_reference
	Last reference number used to send a packet.

IUnits	_units
	List containing pointers to the units present in the device.

Protocol::Filters::ResponseRequired	response_filter
	Support for generating missing responses for messages.

Detailed Description

template<typename Base, typename... ITF>
class HF::Unit0< Base, ITF >

Helper template class used to define custom Unit 0 for devices.

Template Parameters

Base	parent class.
ITF	custom classes implementing the required services.

Definition at line 264 of file core.h.

Member Enumeration Documentation

◆ Inferface

template<typename Base, typename... ITF>

enum HF::Unit0::Inferface : uint8_t

Core Services indexs.

Enumerator
DEV_INFO	Device Information service index.
DEV_MGT	Device Management service index.
ATTR_RPT	Attribute Reporting service index.
BIND_MGT	Bind Management service index.

Definition at line 275 of file core.h.

                     : uint8_t
       {
          DEV_INFO = 0,     
          DEV_MGT,          
          ATTR_RPT,         
 #if HF_TIME_SUPPORT
          TIME,             
 #endif
 #if HF_BATCH_PROGRAM_SUPPORT
          BATCH_PROGRAM,    
 #endif
 #if HF_EVENT_SCHEDULING_SUPPORT
          EVENT_SCH,        
 #endif
 #if HF_WEEKLY_SCHEDULING_SUPPORT
          WEEKLY_SCH,       
 #endif
 #if HF_GROUP_SUPPORT
          GROUP_TABLE,      
          GROUP_MGT,        
 #endif
          BIND_MGT,         
       };

Constructor & Destructor Documentation

◆ Unit0()

template<typename Base, typename... ITF>

HF::Unit0< Base, ITF >::Unit0 ( HF::IDevice & device )

inline

Constructor.

Parameters

[in] device reference to the device that this unit belongs to.

Definition at line 351 of file core.h.

                               :
          Base(device), InterfacesWrapper(*(static_cast<Base *>(this)))
       {}

Member Function Documentation

◆ attribute_reporting() [1/2]

template<typename Base, typename... ITF>

AttrReporting* HF::Unit0< Base, ITF >::attribute_reporting ( ) const

inline

Attribute Reporting service.

Returns: pointer to the Attribute Reporting service

Definition at line 402 of file core.h.

       {
          return get<AttrReporting, ATTR_RPT>();
       }

◆ attribute_reporting() [2/2]

template<typename Base, typename... ITF>

AttrReporting* HF::Unit0< Base, ITF >::attribute_reporting ( )

inline

Attribute Reporting service.

Returns: pointer to the Attribute Reporting service

Definition at line 412 of file core.h.

       {
          return get<AttrReporting, ATTR_RPT>();
       }

◆ attributes()

template<typename Base, typename... ITF>

HF::Attributes::List HF::Unit0< Base, ITF >::attributes	(	Common::Interface	itf,
		uint8_t	pack_id,
		const HF::Attributes::UIDS &	uids
	)		const

inline

Return a list of all the attributes for a given interface, pack id and list of attributes UID's.

Parameters

[in]	itf	interface UID.
[in]	pack_id	attribute pack id.
[in]	uids	list of attributes UID's.

Returns: attribute list.

Definition at line 554 of file core.h.

       {
          HF::Attributes::List result;
          InterfacesWrapper::attributes(result, itf, pack_id, uids);
          return result;
       }

◆ device_info() [1/2]

template<typename Base, typename... ITF>

DeviceInfo* HF::Unit0< Base, ITF >::device_info ( ) const

inline

Device Information service.

Returns: pointer to the Device Information service

Definition at line 362 of file core.h.

       {
          return get<DeviceInfo, DEV_INFO>();
       }

◆ device_info() [2/2]

template<typename Base, typename... ITF>

DeviceInfo* HF::Unit0< Base, ITF >::device_info ( )

inline

Device Information service.

Returns: pointer to the Device Information service

Definition at line 372 of file core.h.

       {
          return get<DeviceInfo, DEV_INFO>();
       }

◆ device_management() [1/2]

template<typename Base, typename... ITF>

DeviceMgt* HF::Unit0< Base, ITF >::device_management ( ) const

inline

Device Management service.

Returns: pointer to the Device Management service

Definition at line 382 of file core.h.

       {
          return get<DeviceMgt, DEV_MGT>();
       }

◆ device_management() [2/2]

template<typename Base, typename... ITF>

DeviceMgt* HF::Unit0< Base, ITF >::device_management ( )

inline

Device Management service.

Returns: pointer to the Device Management service

Definition at line 392 of file core.h.

       {
          return get<DeviceMgt, DEV_MGT>();
       }

◆ handle()

template<typename Base, typename... ITF>

Common::Result HF::Unit0< Base, ITF >::handle	(	HF::Protocol::Packet &	packet,
		Common::ByteArray &	payload,
		uint16_t	offset
	)

inline

Handle incoming messages from the network.

Parameters

[in]	packet	the packet receive from the network.
[in]	payload	the byte array containing the data received from the network.
[in]	offset	the offset the payload start at in the byte array.

Returns: the result of the message processing.

Definition at line 532 of file core.h.

       {
 #if HF_GROUP_SUPPORT
          Common::Result result = Common::Result::FAIL_UNKNOWN;
          InterfacesWrapper::for_each([&result, &packet, &payload, offset](HF::Interface &itf)
          {
             if (result != Common::Result::OK) // Message already handled, skip.
             {
                result = itf.handle(packet, payload, offset);
             }
          });
 
          return result;
 
 #else
          return InterfacesWrapper::handle(packet, payload, offset);
 
 #endif
       }

◆ periodic()

template<typename Base, typename... ITF>

void HF::Unit0< Base, ITF >::periodic ( uint32_t time )

inlinevirtual

Handle periodic processing.

Parameters

[in] time current system clock value in seconds.

Implements HF::IDevice.

Definition at line 562 of file core.h.

       {
          Base::periodic(time);
          InterfacesWrapper::periodic(time);
       }

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

core.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename Base, typename... ITF> class HF::Unit0< Base, ITF >

Member Enumeration Documentation

◆ Inferface

Constructor & Destructor Documentation

◆ Unit0()

Member Function Documentation

◆ attribute_reporting() [1/2]

◆ attribute_reporting() [2/2]

◆ attributes()

◆ device_info() [1/2]

◆ device_info() [2/2]

◆ device_management() [1/2]

◆ device_management() [2/2]

◆ handle()

◆ periodic()

template<typename Base, typename... ITF>
class HF::Unit0< Base, ITF >