HF::Units::Unit< Profile, ITF > Class Template Reference

Helper template class to implement units. More...

#include <units.h>

Inheritance diagram for HF::Units::Unit< Profile, ITF >:

Collaboration diagram for HF::Units::Unit< Profile, ITF >:

Public Member Functions
	Unit (uint8_t id, 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...
Common::Result	handle (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	send (const Protocol::Address &addr, Protocol::Message &message)
	Send message msg to the network address given by addr. 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...
std::vector< Common::Interface >	interfaces () const
	Return the list of optional interfaces implemented by this unit. More...
void	periodic (uint32_t time)
	Handle periodic processing. More...
Public Member Functions inherited from HF::Units::AbstractUnit
IDevice &	device () 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...
Public Member Functions inherited from HF::Interfaces::Container< HF::Units::Unit< Profile, ITF... >, Proxy< ITF, HF::Units::Unit< Profile, ITF... > >... >
	Container (HF::Units::Unit< Profile, ITF... > &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::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 Member Functions inherited from HF::Interfaces::Container< HF::Units::Unit< Profile, ITF... >, Proxy< ITF, HF::Units::Unit< Profile, ITF... > >... >
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::Units::AbstractUnit
uint8_t	_id
	Unit ID used to identify a given unit in a given HAN-FUN device.

Detailed Description

template<class Profile, typename... ITF>
class HF::Units::Unit< Profile, ITF >

Helper template class to implement units.

Definition at line 196 of file units.h.

Constructor & Destructor Documentation

Unit()

template<class Profile, typename... ITF>

HF::Units::Unit< Profile, ITF >::Unit ( uint8_t  id, IDevice &  device  )

inline

Constructor.

Parameters

[in]	id	unit identifier.
[in]	device	device that contains this units.

Definition at line 212 of file units.h.

                                          :
            Profile(), HF::Units::AbstractUnit(device),
            Wrapper(*this), _id(id)
         {}

Member Function Documentation

attributes()

template<class Profile, typename... ITF>

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

inlinevirtual

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.

Implements HF::Profiles::IProfile.

Definition at line 245 of file units.h.

         {
            auto result = Profile::attributes(itf, pack_id, uids);

            Wrapper::attributes(result, itf, pack_id, uids);

            return result;
         }

handle()

template<class Profile, typename... ITF>

Common::Result HF::Units::Unit< Profile, ITF >::handle ( Protocol::Packet &  packet, Common::ByteArray &  payload, uint16_t  offset  )

inlinevirtual

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.

Implements HF::Units::IUnit.

Definition at line 230 of file units.h.

         {
            Common::Result result = Profile::handle(packet, payload, offset);

            // Message not handled by base profile, then try extra interfaces.
            if (result == Common::Result::FAIL_ARG)
            {
               return Wrapper::handle(packet, payload, offset);
            }

            return result;
         }

id()

template<class Profile, typename... ITF>

uint8_t HF::Units::Unit< Profile, ITF >::id ( ) const

inlinevirtual

Get the id number of this unit on the device.

Returns

id number of this unit on the device.

Implements HF::Units::IUnit.

Definition at line 218 of file units.h.

         {
            return _id;
         }

interfaces()

template<class Profile, typename... ITF>

std::vector<Common::Interface> HF::Units::Unit< Profile, ITF >::interfaces ( ) const

inlinevirtual

Return the list of optional interfaces implemented by this unit.

Returns

a vector containing the UIDs for the optional interfaces implemented by this unit.

Reimplemented from HF::Units::AbstractUnit.

Definition at line 276 of file units.h.

         {
            return Wrapper::interfaces();
         }

notify()

template<class Profile, typename... ITF>

void HF::Units::Unit< Profile, ITF >::notify ( const HF::Attributes::IAttribute &  old_value, const HF::Attributes::IAttribute &  new_value  ) const

inline

Notify the attribute reporting service that the given attribute has changed value.

Parameters

[in]	old_value	reference to the previous value of the attribute.
[in]	new_value	reference to the current value of the attribute.

Definition at line 264 of file units.h.

         {
            AbstractUnit::notify(old_value, new_value);
         }

periodic()

template<class Profile, typename... ITF>

void HF::Units::Unit< Profile, ITF >::periodic ( uint32_t  time )

inlinevirtual

Handle periodic processing.

Parameters

[in]

time

current system clock value in seconds.

Reimplemented from HF::Units::AbstractUnit.

Definition at line 281 of file units.h.

         {
            Profile::periodic(time);
            Wrapper::periodic(time);
         }

send()

template<class Profile, typename... ITF>

void HF::Units::Unit< Profile, ITF >::send ( const Protocol::Address &  addr, Protocol::Message &  message  )

inline

Send message msg to the network address given by addr.

Parameters

[in]	addr	HF network address.
[in]	message	pointer to the message to be sent to the network.

Definition at line 258 of file units.h.

         {
            AbstractUnit::send(addr, message, nullptr);
         }

uid()

template<class Profile, typename... ITF>

uint16_t HF::Units::Unit< Profile, ITF >::uid ( ) const

inlinevirtual

Return this profile HAN-FUN UID.

Returns

the UID associated with this profile.

See also

IProfile::UID.

Implements HF::Profiles::IProfile.

Definition at line 224 of file units.h.

         {
            return Profile::uid();
         }

---

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

• units.h