flxStorageJSONPrefFile Class Reference

#include <flxStorageJSONPref.h>

Inheritance diagram for flxStorageJSONPrefFile:

Public Member Functions
	flxStorageJSONPrefFile ()
virtual bool	begin (bool readonly=false)
virtual void	end (void)
void	setFileSystem (flxIFileSystem *)
void	setFilename (std::string &name)
void	setFilename (const char *name)
Public Member Functions inherited from flxStorageJSONPref
	flxStorageJSONPref ()
	flxStorageJSONPref (size_t buffer_size)
flxStorageKind_t	kind (void)
virtual bool	begin (bool readonly=false)
virtual void	end (void)
flxStorageJSONBlock *	beginBlock (const char *tag)
flxStorageJSONBlock *	getBlock (const char *tag)
void	endBlock (flxStorageBlock *)
void	resetStorage ()
void	setBufferSize (size_t new_size)
size_t	bufferSize (void)
virtual flxStorageKind_t	kind (void)=0
virtual bool	begin (bool readonly=false)=0
virtual void	end (void)=0
virtual flxStorageBlock *	beginBlock (const char *tag)=0
virtual flxStorageBlock *	getBlock (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
Public Types inherited from flxStorage
enum	flxStorageKind_t { flxStorageKindInternal , flxStorageKindExternal }
Protected Attributes inherited from flxStorageJSONPref
flxStorageJSONBlock	_theBlock
DynamicJsonDocument *	_pDocument
bool	_readOnly
size_t	_jsonDocSize
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Constructor & Destructor Documentation

flxStorageJSONPrefFile()

flxStorageJSONPrefFile::flxStorageJSONPrefFile ( )

inline

Member Function Documentation

begin()

bool flxStorageJSONPrefFile::begin ( bool  readonly = false )

virtual

Reimplemented from flxStorageJSONPref.

end()

void flxStorageJSONPrefFile::end ( void  )

virtual

Reimplemented from flxStorageJSONPref.

setFilename() [1/2]

void flxStorageJSONPrefFile::setFilename ( const char *  name )

inline

setFilename() [2/2]

void flxStorageJSONPrefFile::setFilename

(

std::string &

name

)

setFileSystem()

void flxStorageJSONPrefFile::setFileSystem

(

flxIFileSystem *

theFilesystem

)

---

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

• src/core/flux_prefs_json/flxStorageJSONPref.h
• src/core/flux_prefs_json/flxStorageJSONPref.cpp