HF::Core::DeviceManagement::Entries Struct Reference

Default implementation of the persistence API. More...

#include <device_management.h>

Inheritance diagram for HF::Core::DeviceManagement::Entries:

Collaboration diagram for HF::Core::DeviceManagement::Entries:

Public Member Functions
uint16_t	size () const
	Return the number of entries in the container. More...
Common::Result	destroy (const Device &entry)
	Destroy the given entry in the persistent storage. More...
DevicePtr	find (uint16_t address) const
	Return the Device entry for the given address. More...
DevicePtr	find (const HF::UID::UID &uid) const
	Return the Device entry for the given UID. More...
uint16_t	next_address () const
	Return next available address for registering a device. More...
iterator	begin ()
	Get an iterator to the start of the entries in this container. More...
iterator	end ()
	Get an iterator to the end of the entries in this container. More...
const_iterator	begin () const
	Get a constant iterator to the start of the entries in this container. More...
const_iterator	end () const
	Get a constant iterator to the start of the entries in this container. More...
Public Member Functions inherited from HF::Common::IEntries< Device >
virtual Result	save (const Device &entry)=0
	Store the given entry to persistent storage. More...
virtual Result	destroy (const Device &entry)=0
	Destroy the given entry in the persistent storage. More...

Protected Attributes
Container	db
	Actual container for the entries.

Detailed Description

Default implementation of the persistence API.

Definition at line 770 of file device_management.h.

Member Function Documentation

begin() [1/2]

iterator HF::Core::DeviceManagement::Entries::begin ( )

inline

Get an iterator to the start of the entries in this container.

Returns

iterator to the start of the entries present in this container.

Definition at line 804 of file device_management.h.

References db.

            {
               return db.begin();
            }

begin() [2/2]

const_iterator HF::Core::DeviceManagement::Entries::begin ( ) const

inline

Get a constant iterator to the start of the entries in this container.

Returns

constant iterator to the start of the entries present in this container.

Definition at line 824 of file device_management.h.

References db.

            {
               return db.cbegin();
            }

destroy()

Common::Result HF::Core::DeviceManagement::Entries::destroy

(

const Device &

entry

)

Destroy the given entry in the persistent storage.

Parameters

[in]

entry

reference to the entry to erase.

Return values

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

Warning

the reference passed into this method SHOULD NOT be considered valid if it was obtained by calling the find method.

end() [1/2]

iterator HF::Core::DeviceManagement::Entries::end ( )

inline

Get an iterator to the end of the entries in this container.

Returns

iterator to the end of the entries present in this container.

Definition at line 814 of file device_management.h.

References db.

            {
               return db.end();
            }

end() [2/2]

const_iterator HF::Core::DeviceManagement::Entries::end ( ) const

inline

Get a constant iterator to the start of the entries in this container.

Returns

constant iterator to the start of the entries present in this container.

Definition at line 834 of file device_management.h.

References db.

            {
               return db.cend();
            }

find() [1/2]

DevicePtr HF::Core::DeviceManagement::Entries::find ( uint16_t  address ) const

virtual

Return the Device entry for the given address.

Parameters

[in]

address

the device address.

Return values

a	pointer to the Device entry associated with the given address,
nullptr	if the entry does not exist.

Implements HF::Core::DeviceManagement::IEntries.

find() [2/2]

DevicePtr HF::Core::DeviceManagement::Entries::find ( const HF::UID::UID &  uid ) const

virtual

Return the Device entry for the given UID.

Parameters

[in]

uid

the device UID.

Return values

a	pointer the Device entry associated with the given UID,
nullptr	if the entry does not exist.

Implements HF::Core::DeviceManagement::IEntries.

next_address()

uint16_t HF::Core::DeviceManagement::Entries::next_address ( ) const

virtual

Return next available address for registering a device.

Returns

the address to use in the next registration.

Implements HF::Core::DeviceManagement::IEntries.

size()

uint16_t HF::Core::DeviceManagement::Entries::size ( ) const

inlinevirtual

Return the number of entries in the container.

Returns

the number of entries in the container.

Implements HF::Common::IEntries< Device >.

Definition at line 777 of file device_management.h.

References db.

            {
               return db.size();
            }

---

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

• device_management.h