HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Core::GroupTable::IEntries Struct Referenceabstract

Group Table persistent storage API. More...

#include <group_table.h>

+ Inheritance diagram for HF::Core::GroupTable::IEntries:
+ Collaboration diagram for HF::Core::GroupTable::IEntries:

Public Member Functions

virtual void clear ()=0
 Clear all entries in database.
 
virtual void for_each (uint16_t group, std::function< void(const Entry &)> func) const =0
 Call the given function for all the entries with given group address. More...
 
virtual Entry const & operator[] (uint8_t index) const =0
 Retrive the entry at the given index. More...
 
- Public Member Functions inherited from HF::Common::IEntries< Entry >
virtual uint16_t size () const=0
 Return the number of entries in the container. More...
 
virtual Result save (const Entry &entry)=0
 Store the given entry to persistent storage. More...
 
virtual Result destroy (const Entry &entry)=0
 Destroy the given entry in the persistent storage. More...
 

Detailed Description

Group Table persistent storage API.

Definition at line 371 of file group_table.h.

Member Function Documentation

◆ for_each()

virtual void HF::Core::GroupTable::IEntries::for_each ( uint16_t  group,
std::function< void(const Entry &)>  func 
) const
pure virtual

Call the given function for all the entries with given group address.

Parameters
[in]groupgroup address to search for.
[in]funcfunction to apply to each member of the group.

Implemented in HF::Core::GroupTable::Entries.

◆ operator[]()

virtual Entry const& HF::Core::GroupTable::IEntries::operator[] ( uint8_t  index) const
pure virtual

Retrive the entry at the given index.

Parameters
[in]indexthe index to retrive the entry from.
Returns
a reference to the requested entry.

Implemented in HF::Core::GroupTable::Entries.


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