flux sdk  v01.05.00-3-gedf3296
Embedded C++ SDK
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
flxKVPStorePrefs Class Reference

#include <flxKVPStorePrefs.h>

Inheritance diagram for flxKVPStorePrefs:
flxKVPStore

Public Member Functions

 flxKVPStorePrefs ()
 
bool begin (const char *name, bool readOnly=false)
 
void end ()
 
size_t putChar (const char *key, int8_t value)
 
size_t putUChar (const char *key, uint8_t value)
 
size_t putShort (const char *key, int16_t value)
 
size_t putUShort (const char *key, uint16_t value)
 
size_t putInt (const char *key, int32_t value)
 
size_t putUInt (const char *key, uint32_t value)
 
size_t putLong (const char *key, int32_t value)
 
size_t putULong (const char *key, uint32_t value)
 
size_t putFloat (const char *key, float value)
 
size_t putDouble (const char *key, double value)
 
size_t putBool (const char *key, bool value)
 
size_t putString (const char *key, const char *value)
 
size_t putBytes (const char *key, const void *value, size_t len)
 
int8_t getChar (const char *key, int8_t defaultValue=0)
 
uint8_t getUChar (const char *key, uint8_t defaultValue=0)
 
int16_t getShort (const char *key, int16_t defaultValue=0)
 
uint16_t getUShort (const char *key, uint16_t defaultValue=0)
 
int32_t getLong (const char *key, int32_t defaultValue=0)
 
uint32_t getULong (const char *key, uint32_t defaultValue=0)
 
int32_t getInt (const char *key, int32_t defaultValue=0)
 
uint32_t getUInt (const char *key, uint32_t defaultValue=0)
 
float getFloat (const char *key, float defaultValue=0.0)
 
double getDouble (const char *key, double defaultValue=0.0)
 
bool getBool (const char *key, bool defaultValue=false)
 
size_t getString (const char *key, char *data, size_t len)
 
String getString (const char *key, const String &defaultValue="")
 
size_t getBytes (const char *key, void *data, size_t len)
 
size_t getBytesLength (const char *key)
 
bool isKey (const char *key)
 
- Public Member Functions inherited from flxKVPStore
 flxKVPStore ()
 
flxKVPError_t initialize (void)
 
uint8_t getNameSpace (const char *szNS)
 
flxKVPError_t setValue (uint8_t iNS, const char *szKey, const char *value)
 
flxKVPError_t setValue (uint8_t iNS, const char *szKey, char *value)
 
template<typename T >
flxKVPError_t setValue (uint8_t iNS, const char *szKey, T &value)
 
flxKVPError_t setValue (uint8_t iNS, const char *szKey, const void *value, size_t valueSize)
 
template<typename T >
flxKVPError_t getValue (uint8_t iNS, const char *szKey, T &value)
 
flxKVPError_t getValue (uint8_t iNS, const char *szKey, char *value, size_t len)
 
flxKVPError_t getValue (uint8_t iNS, const char *szKey, void *value, size_t len)
 
flxKVPError_t deleteValue (uint8_t iNS, const char *szKey)
 
bool keyExists (uint8_t iNS, const char *szKey)
 
void commit (void)
 
void reset (void)
 
void setStorageDevice (flxKVPStoreDevice *device)
 
void setStorageDevice (flxKVPStoreDevice &device)
 

Static Public Attributes

static constexpr const int32_t kNoNameSpace = -1
 
- Static Public Attributes inherited from flxKVPStore
static constexpr int16_t kNullPage = -1
 

Additional Inherited Members

- Protected Member Functions inherited from flxKVPStore
flxKVPError_t getNameSpaceIndex (const char *szNS, uint8_t &outNSIndex)
 

Constructor & Destructor Documentation

◆ flxKVPStorePrefs()

flxKVPStorePrefs::flxKVPStorePrefs ( )
inline

Member Function Documentation

◆ begin()

bool flxKVPStorePrefs::begin ( const char *  name,
bool  readOnly = false 
)
inline

◆ end()

void flxKVPStorePrefs::end ( )
inline

◆ getBool()

bool flxKVPStorePrefs::getBool ( const char *  key,
bool  defaultValue = false 
)
inline

◆ getBytes()

size_t flxKVPStorePrefs::getBytes ( const char *  key,
void *  data,
size_t  len 
)
inline

◆ getBytesLength()

size_t flxKVPStorePrefs::getBytesLength ( const char *  key)
inline

◆ getChar()

int8_t flxKVPStorePrefs::getChar ( const char *  key,
int8_t  defaultValue = 0 
)
inline

◆ getDouble()

double flxKVPStorePrefs::getDouble ( const char *  key,
double  defaultValue = 0.0 
)
inline

◆ getFloat()

float flxKVPStorePrefs::getFloat ( const char *  key,
float  defaultValue = 0.0 
)
inline

◆ getInt()

int32_t flxKVPStorePrefs::getInt ( const char *  key,
int32_t  defaultValue = 0 
)
inline

◆ getLong()

int32_t flxKVPStorePrefs::getLong ( const char *  key,
int32_t  defaultValue = 0 
)
inline

◆ getShort()

int16_t flxKVPStorePrefs::getShort ( const char *  key,
int16_t  defaultValue = 0 
)
inline

◆ getString() [1/2]

size_t flxKVPStorePrefs::getString ( const char *  key,
char *  data,
size_t  len 
)
inline

◆ getString() [2/2]

String flxKVPStorePrefs::getString ( const char *  key,
const String &  defaultValue = "" 
)
inline

◆ getUChar()

uint8_t flxKVPStorePrefs::getUChar ( const char *  key,
uint8_t  defaultValue = 0 
)
inline

◆ getUInt()

uint32_t flxKVPStorePrefs::getUInt ( const char *  key,
uint32_t  defaultValue = 0 
)
inline

◆ getULong()

uint32_t flxKVPStorePrefs::getULong ( const char *  key,
uint32_t  defaultValue = 0 
)
inline

◆ getUShort()

uint16_t flxKVPStorePrefs::getUShort ( const char *  key,
uint16_t  defaultValue = 0 
)
inline

◆ isKey()

bool flxKVPStorePrefs::isKey ( const char *  key)
inline

◆ putBool()

size_t flxKVPStorePrefs::putBool ( const char *  key,
bool  value 
)
inline

◆ putBytes()

size_t flxKVPStorePrefs::putBytes ( const char *  key,
const void *  value,
size_t  len 
)
inline

◆ putChar()

size_t flxKVPStorePrefs::putChar ( const char *  key,
int8_t  value 
)
inline

◆ putDouble()

size_t flxKVPStorePrefs::putDouble ( const char *  key,
double  value 
)
inline

◆ putFloat()

size_t flxKVPStorePrefs::putFloat ( const char *  key,
float  value 
)
inline

◆ putInt()

size_t flxKVPStorePrefs::putInt ( const char *  key,
int32_t  value 
)
inline

◆ putLong()

size_t flxKVPStorePrefs::putLong ( const char *  key,
int32_t  value 
)
inline

◆ putShort()

size_t flxKVPStorePrefs::putShort ( const char *  key,
int16_t  value 
)
inline

◆ putString()

size_t flxKVPStorePrefs::putString ( const char *  key,
const char *  value 
)
inline

◆ putUChar()

size_t flxKVPStorePrefs::putUChar ( const char *  key,
uint8_t  value 
)
inline

◆ putUInt()

size_t flxKVPStorePrefs::putUInt ( const char *  key,
uint32_t  value 
)
inline

◆ putULong()

size_t flxKVPStorePrefs::putULong ( const char *  key,
uint32_t  value 
)
inline

◆ putUShort()

size_t flxKVPStorePrefs::putUShort ( const char *  key,
uint16_t  value 
)
inline

Member Data Documentation

◆ kNoNameSpace

constexpr const int32_t flxKVPStorePrefs::kNoNameSpace = -1
staticconstexpr
The documentation for this class was generated from the following file: