HF::Core::GroupManagement::IEntries Struct Reference

Device Management - Persistent Storage API. More...

#include <group_management.h>

Inheritance diagram for HF::Core::GroupManagement::IEntries:

Collaboration diagram for HF::Core::GroupManagement::IEntries:

Public Member Functions
virtual Common::Result	save (uint16_t address, const std::string &name)=0
	Store the given entry to persistent storage. More...
virtual Common::Result	destroy (const uint16_t address)=0
	Destroy the entry given by address in the persistent storage. More...
virtual GroupPtr	find (const uint16_t address) const =0
	Find the group with the given group address. More...
virtual GroupPtr	find (const std::string &name) const =0
	Find the group with the given name. More...
virtual uint16_t	next_address () const =0
	Return next available address for device group. More...
Public Member Functions inherited from HF::Common::IEntries< Group >
virtual uint16_t	size () const=0
	Return the number of entries in the container. More...
virtual Result	save (const Group &entry)=0
	Store the given entry to persistent storage. More...
virtual Result	destroy (const Group &entry)=0
	Destroy the given entry in the persistent storage. More...

Detailed Description

Device Management - Persistent Storage API.

Definition at line 582 of file group_management.h.

Member Function Documentation

destroy()

virtual Common::Result HF::Core::GroupManagement::IEntries::destroy ( const uint16_t  address )

pure virtual

Destroy the entry given by address in the persistent storage.

Parameters

[in]

address

the address to the entry to erase.

Return values

Common::Result::OK,if	the entry was destroyed.
Common::Result::FAIL_ARG	otherwise.

Implemented in HF::Core::GroupManagement::Entries.

find() [1/2]

virtual GroupPtr HF::Core::GroupManagement::IEntries::find ( const uint16_t  address ) const

pure virtual

Find the group with the given group address.

Parameters

[in]

address

HF address to search for.

Returns

pointer to the group with the given address, nullptr otherwise.

Implemented in HF::Core::GroupManagement::Entries.

Referenced by HF::Core::GroupManagement::IServer::entry().

Here is the caller graph for this function:

find() [2/2]

virtual GroupPtr HF::Core::GroupManagement::IEntries::find ( const std::string &  name ) const

pure virtual

Find the group with the given name.

Parameters

[in]

name

group name to search for.

Returns

pointer to the group with the given name, nullptr otherwise.

Implemented in HF::Core::GroupManagement::Entries.

next_address()

virtual uint16_t HF::Core::GroupManagement::IEntries::next_address ( ) const

pure virtual

Return next available address for device group.

Returns

the address to use in the next group, or GroupAddress::NO_ADDR if no address is available.

Implemented in HF::Core::GroupManagement::Entries.

Referenced by HF::Core::GroupManagement::IServer::next_address().

Here is the caller graph for this function:

save()

virtual Common::Result HF::Core::GroupManagement::IEntries::save ( uint16_t  address, const std::string &  name  )

pure virtual

Store the given entry to persistent storage.

Parameters

[in]	address	HF group address for the new group.
[in]	name	name for the new group.

Return values

Common::Result::OK	if the entry was saved,
Common::Result::FAIL_UNKNOWN	otherwise.

Implemented in HF::Core::GroupManagement::Entries.

---

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

• group_management.h