Skyward boardcore
Loading...
Searching...
No Matches
Boardcore::RegistryBackend Class Referenceabstract

Registry Backend class used to save and load data to the designated storage/memory. More...

#include <RegistryBackend.h>

Inheritance diagram for Boardcore::RegistryBackend:

Public Member Functions

virtual bool start ()=0
 Starts the backend, eventually used in backends that need to start classes and other things e.g. an ActiveObject.
 
virtual bool load (std::vector< uint8_t > &buf)=0
 Loads into the buffer the saved configuration from the storage/memory.
 
virtual bool save (std::vector< uint8_t > &buf)=0
 Saves the data in the buf to the storage/memory.
 

Detailed Description

Registry Backend class used to save and load data to the designated storage/memory.

Definition at line 36 of file RegistryBackend.h.

Member Function Documentation

◆ load()

virtual bool Boardcore::RegistryBackend::load ( std::vector< uint8_t > & buf)
pure virtual

Loads into the buffer the saved configuration from the storage/memory.

Parameters
bufThe buffer where the data will be loaded from the storage/memory if any is saved.
Returns
true if successful, false otherwise.

Implemented in Boardcore::FileBackend, and Boardcore::DummyBackend.

◆ save()

virtual bool Boardcore::RegistryBackend::save ( std::vector< uint8_t > & buf)
pure virtual

Saves the data in the buf to the storage/memory.

Parameters
bufThe buf vector with the data to be saved.
Returns
true if successful, false otherwise.

Implemented in Boardcore::FileBackend, and Boardcore::DummyBackend.

◆ start()

virtual bool Boardcore::RegistryBackend::start ( )
pure virtual

Starts the backend, eventually used in backends that need to start classes and other things e.g. an ActiveObject.

Returns
true if successful, false otherwise

Implemented in Boardcore::FileBackend, and Boardcore::DummyBackend.


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