Zigbee Protocol Controller 1.6.0

#include <zigpc_datastore_accessor.hpp>

Inheritance diagram for ClusterAccessor:
StoreAccessor< zcl_cluster_id_t, zigpc_cluster_data_t >

Public Member Functions

 ClusterAccessor (zcl_cluster_side_t cluster_side)
 
std::string to_str (attribute_store_node_t parent, zcl_cluster_id_t cluster_id) override
 Return string representation of cluster entity. More...
 
- Public Member Functions inherited from StoreAccessor< zcl_cluster_id_t, zigpc_cluster_data_t >
 StoreAccessor (attribute_store_type_t node_type, std::string label)
 
virtual ~StoreAccessor ()=default
 
std::string get_label (void) const
 
attribute_store_type_t get_node_type (void) const
 
attribute_store_node_t find (attribute_store_node_t parent, zcl_cluster_id_t key)
 Find an entity based based on the key. More...
 
size_t child_count (attribute_store_node_t parent, zcl_cluster_id_t key, attribute_store_type_t child_type)
 Retrive the count of child entities by type. More...
 
sl_status_t find_by_index (attribute_store_node_t parent, size_t index, zcl_cluster_id_t *key)
 Find the search key of the child entity based on the index. More...
 
sl_status_t create (attribute_store_node_t parent, zcl_cluster_id_t key)
 Create a new entity based on the search key. More...
 
sl_status_t read (attribute_store_node_t parent, zcl_cluster_id_t key, zigpc_cluster_data_t *const data)
 Read information of the entity. More...
 
sl_status_t write (attribute_store_node_t parent, zcl_cluster_id_t key, const zigpc_cluster_data_t *data)
 Write information to the entity. More...
 
sl_status_t remove (attribute_store_node_t parent, zcl_cluster_id_t key)
 Remove the entity from the store. More...
 
sl_status_t remove_children (attribute_store_node_t parent, zcl_cluster_id_t key)
 Remove all child entities from the store. More...
 
virtual std::string to_str (attribute_store_node_t parent, zcl_cluster_id_t key)
 Get string representation of entity in byte buffer representation. More...
 

Static Public Member Functions

static std::string get_label_type (zcl_cluster_side_t cluster_side)
 Get the label based on the cluster side used. More...
 
static attribute_store_type_t get_entity_type (zcl_cluster_side_t cluster_side)
 Retrieve the attribute store node type of the cluster based on the cluster side received. More...
 

Private Attributes

zcl_cluster_side_t cluster_side
 

Constructor & Destructor Documentation

◆ ClusterAccessor()

ClusterAccessor::ClusterAccessor ( zcl_cluster_side_t  cluster_side)
explicit

Member Function Documentation

◆ get_entity_type()

static attribute_store_type_t ClusterAccessor::get_entity_type ( zcl_cluster_side_t  cluster_side)
inlinestatic

Retrieve the attribute store node type of the cluster based on the cluster side received.

Parameters
cluster_side
Returns
attribute_store_type_t ZIGPC_DS_TYPE_SERVER_CLUSTER for server side or ZIGPC_DS_TYPE_CLIENT_CLUSTER otherwise.

◆ get_label_type()

static std::string ClusterAccessor::get_label_type ( zcl_cluster_side_t  cluster_side)
inlinestatic

Get the label based on the cluster side used.

Parameters
cluster_side
Returns
std::string

◆ to_str()

std::string ClusterAccessor::to_str ( attribute_store_node_t  parent,
zcl_cluster_id_t  cluster_id 
)
overridevirtual

Return string representation of cluster entity.

Parameters
parentParent of cluster entity (endpoint entity).
cluster_idCluster identifer to search.
Returns
std::string Cluster data in string form, else empty string if entity is not stored.

Reimplemented from StoreAccessor< zcl_cluster_id_t, zigpc_cluster_data_t >.

Member Data Documentation

◆ cluster_side

zcl_cluster_side_t ClusterAccessor::cluster_side
private

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