SensESP 3.0.1
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::FileSystemSaveable Class Reference

#include <sensesp/system/saveable.h>

Inheritance diagram for sensesp::FileSystemSaveable:
[legend]

Public Member Functions

 FileSystemSaveable (const String &config_path)
 
virtual bool load () override
 Load and populate the object from a persistent storage.
 
virtual bool save () override
 Save the object to a persistent storage.
 
virtual bool clear () override
 Delete the data from a persistent storage.
 
bool find_config_file (const String &config_path, String &filename)
 
- Public Member Functions inherited from sensesp::Saveable
 Saveable (const String &config_path)
 
virtual bool refresh ()
 Refresh the object. This may or may not access the persistent storage but is not expected to overwrite the object's state.
 
const String & get_config_path () const
 
- Public Member Functions inherited from sensesp::Serializable
virtual bool to_json (JsonObject &root)
 
virtual bool from_json (const JsonObject &root)
 

Additional Inherited Members

- Protected Attributes inherited from sensesp::Saveable
const String config_path_
 

Detailed Description

Definition at line 61 of file saveable.h.

Constructor & Destructor Documentation

◆ FileSystemSaveable()

sensesp::FileSystemSaveable::FileSystemSaveable ( const String & config_path)
inline

Definition at line 63 of file saveable.h.

Member Function Documentation

◆ clear()

bool sensesp::FileSystemSaveable::clear ( )
overridevirtual

Delete the data from a persistent storage.

Returns
true
false

Reimplemented from sensesp::Saveable.

Definition at line 72 of file saveable.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ find_config_file()

bool sensesp::FileSystemSaveable::find_config_file ( const String & config_path,
String & filename )

Definition at line 90 of file saveable.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ load()

bool sensesp::FileSystemSaveable::load ( )
overridevirtual

Load and populate the object from a persistent storage.

Returns
true Object loaded successfully
false

Reimplemented from sensesp::Saveable.

Definition at line 8 of file saveable.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ save()

bool sensesp::FileSystemSaveable::save ( )
overridevirtual

Save the object to a persistent storage.

Returns
true
false

Reimplemented from sensesp::Saveable.

Definition at line 41 of file saveable.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

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