flux sdk  v01.02.02-3-g292b3a7
Embedded C++ SDK
Loading...
Searching...
No Matches
flxStorage Class Referenceabstract

#include <flxStorage.h>

Inheritance diagram for flxStorage:
flxDescriptor flxStorageJSONPref flxStorageJSONPrefFile flxStorageJSONPrefSerial

Public Types

enum  flxStorageKind_t { flxStorageKindInternal , flxStorageKindExternal }
 

Public Member Functions

virtual flxStorageKind_t kind (void)=0
 
virtual bool begin (bool readonly=false)=0
 
virtual void end (void)=0
 
virtual flxStorageBlockbeginBlock (const char *tag)=0
 
virtual flxStorageBlockgetBlock (const char *tag)=0
 
virtual void endBlock (flxStorageBlock *)=0
 
virtual void resetStorage ()=0
 
virtual void setBufferSize (size_t sz)
 
virtual size_t bufferSize (void)
 
- Public Member Functions inherited from flxDescriptor
 flxDescriptor ()
 
void setName (const char *new_name)
 Set the Name object - storing the pointer to the provided string No allocation is performed. If the previous name was allocated, it is freed. More...
 
void setName (const char *new_name, const char *new_desc)
 Set the Name object and the Description for the object. Both strings are constants. More...
 
void setName (char *new_name)
 Set the Name object, but makes a copy of the input string since the input is not const. If the previous name was allocated, it is freed. More...
 
const char * name ()
 Return a const char pointer to the name of the object. More...
 
std::string name_ (void)
 Returns a std::string of the name of the object. More...
 
void setDescription (const char *new_desc)
 Set the Description object - the input value is constant and not copied. If the previous description was allocated, it is freed. More...
 
void setDescription (char *new_desc)
 Set the Description object - the input value is not constant and is copied. If the previous description was allocated, it is freed. More...
 
const char * description ()
 Return the constant C string pointer to the description of the object. More...
 
std::string description_ (void)
 Return the description of the object as a std::string. More...
 
void setTitle (const char *title)
 Set the Title object - the title is optional and is used mostly for UX or organizational purposes. The input value is constant and not copied. If the previous title was allocated, it is freed. More...
 
void setTitleAlloc (char *new_title)
 Set the Title of the object , but make an explict copy of the provided string. More...
 
const char * title (void)
 Return the C constant string pointer to the title of the object. More...
 

Additional Inherited Members

- Protected Attributes inherited from flxDescriptor
const char * _name
 
bool _nameAlloc
 
const char * _desc
 
bool _descAlloc
 
const char * _title
 
bool _titleAlloc
 

Member Enumeration Documentation

◆ flxStorageKind_t

Enumerator
flxStorageKindInternal 
flxStorageKindExternal 

Member Function Documentation

◆ begin()

virtual bool flxStorage::begin ( bool  readonly = false)
pure virtual

◆ beginBlock()

virtual flxStorageBlock * flxStorage::beginBlock ( const char *  tag)
pure virtual

Implemented in flxStorageJSONPref.

◆ bufferSize()

virtual size_t flxStorage::bufferSize ( void  )
inlinevirtual

Reimplemented in flxStorageJSONPref.

◆ end()

virtual void flxStorage::end ( void  )
pure virtual

◆ endBlock()

virtual void flxStorage::endBlock ( flxStorageBlock )
pure virtual

Implemented in flxStorageJSONPref.

◆ getBlock()

virtual flxStorageBlock * flxStorage::getBlock ( const char *  tag)
pure virtual

Implemented in flxStorageJSONPref.

◆ kind()

virtual flxStorageKind_t flxStorage::kind ( void  )
pure virtual

Implemented in flxStorageJSONPref.

◆ resetStorage()

virtual void flxStorage::resetStorage ( )
pure virtual

Implemented in flxStorageJSONPref.

◆ setBufferSize()

virtual void flxStorage::setBufferSize ( size_t  sz)
inlinevirtual

Reimplemented in flxStorageJSONPref.


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