zwave_tx_groups_internal.hpp

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZWAVE_TX_GROUPS_INTERNAL_HPP
#define ZWAVE_TX_GROUPS_INTERNAL_HPP
 
// Generic includes
#include <set>
 
constexpr zwave_multicast_group_id_t MAXIMUM_ZWAVE_TX_GROUP_ID = 255;
 
struct zwave_tx_group_t {
  zwave_multicast_group_id_t group_id;
  zwave_nodemask_t node_list;
  bool locked;
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct zwave_tx_group_compare {
  bool operator()(const zwave_tx_group_t &lhs,
                  const zwave_tx_group_t &rhs) const
  {
    return lhs.group_id > rhs.group_id;
  }
};
 
// Our private list of groups
class zwave_tx_groups
{
  private:
  // List of assigned groups.
  std::set<zwave_tx_group_t, zwave_tx_group_compare> groups;
  // Variable to keep track of the next group to reuse
  zwave_multicast_group_id_t next_group_id_to_reuse = 1;
 
  void increment_next_group_id();
 
  zwave_multicast_group_id_t get_next_group_to_reuse();
 
  sl_status_t analyze_group_suitability(const zwave_nodemask_t nodes,
                                        const zwave_nodemask_t group_nodes,
                                        uint16_t *common_nodes) const;
  bool is_node_list_empty(const zwave_nodemask_t nodes) const;
 
  zwave_multicast_group_id_t
    get_most_similar_subgroup(const zwave_nodemask_t nodes) const;
 
  sl_status_t get_group_data(zwave_tx_group_t *group_data,
                             zwave_multicast_group_id_t group_id) const;
 
  sl_status_t create_or_update_group(const zwave_tx_group_t &new_group);
 
  public:
  zwave_tx_groups();
  ~zwave_tx_groups();
 
  sl_status_t add_node_to_group(zwave_node_id_t node_id,
                                zwave_multicast_group_id_t group_id);
 
  sl_status_t assign_group(const zwave_nodemask_t nodes,
                           zwave_multicast_group_id_t *group_id);
 
  sl_status_t get_nodes(zwave_nodemask_t nodes,
                        zwave_multicast_group_id_t group_id);
 
  sl_status_t lock_group(zwave_multicast_group_id_t group_id);
 
  sl_status_t unlock_group(zwave_multicast_group_id_t group_id);
 
  bool is_group_locked(zwave_multicast_group_id_t group_id);
 
  void log(zwave_multicast_group_id_t group_id);
};
 
#ifdef __cplusplus
}
#endif
 
#endif  //ZWAVE_TX_GROUPS_INTERNAL_HPP