attributes.h File Reference

This file contains the definitions for the attribute handling API in HAN-FUN. More...

#include "hanfun/common.h"
#include "hanfun/protocol.h"

Include dependency graph for attributes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	HF::Attributes::IAttribute
	Interface/Service Attribute API. More...
struct	HF::Attributes::UIDS
	List of attributes UIDs. More...
class	HF::Attributes::AbstractAttribute
	Parent class for Attribute API implementation. More...
struct	HF::Attributes::Attribute< T, _Owner, typename >
	Helper template class to declare an attribute with the given T type. More...
struct	HF::Attributes::Attribute< T, _Owner, EnableIf(IsParent(HF::Interface, _Owner))>
	Helper template class to declare an attribute with the given T type. More...
struct	HF::Attributes::List
	This class has the same behavior has a list, however the list element access methods where overwritten to allow using the attribute UIDs as indexes. More...
struct	HF::Attributes::Response
	This class represents the response sent when a Protocol::Message::GET_ATTR_REQ request. More...
struct	HF::Protocol::GetAttributePack::Request
	This class represents the payload of a HF::Message::GET_ATTR_PACK_REQ request, when the payload is Type::DYNAMIC. More...
struct	HF::Protocol::GetAttributePack::Response
	This class represents the payload of a HF::Message::GET_ATTR_PACK_RES message. More...
struct	HF::Protocol::SetAttributePack::Request
	This class represents the message payload of a HF::Message::SET_ATTR_PACK_REQ or HF::Message::SET_ATTR_PACK_RESP_REQ message. More...
struct	HF::Protocol::SetAttributePack::Response
	This class represents the payload of a HF::Message::SET_ATTR_PACK_RES message. More...
struct	HF::Protocol::SetAttributePack::Response::Result
	Set attribute operation result. More...

Namespaces
	HF
	Top-level namespace for the HAN-FUN library.
	HF::Attributes
	This is the top-level namespace for the classes that implement the interface's attribute manipulation functionality.
	HF::Protocol
	HAN-FUN Protocol implementation.
	HF::Protocol::GetAttributePack
	This namespace contains the classes that implement the HF::Message::GET_ATTR_PACK_REQ messages.
	HF::Protocol::SetAttributePack
	This namespace contains the classes that implement the HF::Message::SET_ATTR_PACK_REQ and HF::Message::SET_ATTR_PACK_RESP_REQ messages.

Typedefs
typedef IAttribute *(*	HF::Attributes::Factory) (uint8_t)
	Attribute factory function type.
typedef Attributes::Factory(*	HF::Attributes::FactoryGetter) (Common::Interface)
	Function pointer to a function that returns the attribute factory associated with a given interface.

Enumerations
enum	HF::Attributes::Pack { HF::Attributes::MANDATORY = 0x00, HF::Attributes::ALL = 0xFE, HF::Attributes::DYNAMIC = 0xFF }
	Attribute Pack Special IDs. More...

Functions
Factory	HF::Attributes::get_factory (Common::Interface itf)
	Return the attribute factory associated with the given interface identifier. More...
List	HF::Attributes::get (const HF::Interface &itf, uint8_t pack_id, const UIDS &uids)
	Get a list with the attributes for the given interface, pack id or the uids passed in. More...

Detailed Description

This file contains the definitions for the attribute handling API in HAN-FUN.

Version

1.5.3

Copyright

Copyright ©   2014 ULE Alliance

For licensing information, please see the file 'LICENSE' in the root folder.

Initial development by Bithium S.A. [http://www.bithium.com]

Definition in file attributes.h.