flxSettingsSerial Class Reference

#include <flxSettingsSerial.h>

Inheritance diagram for flxSettingsSerial:

Public Member Functions
	flxSettingsSerial ()
void	setSystemRoot (flxObjectContainer *theRoot)
bool	drawPage (flxObject *)
bool	drawPage (flxObject *, flxProperty *)
bool	drawPage (flxOperation *)
bool	drawPage (flxOperation *, flxParameter *)
bool	drawPage (flxOperation *, flxParameterIn *)
bool	drawPage (flxObject *, flxParameterIn *, flxDataLimit *)
bool	drawPage (flxObject *, flxProperty *, flxDataLimit *)
bool	drawPage (flxObjectContainer *)
bool	drawPage (flxOperationContainer *)
bool	drawPage (flxActionContainer *)
bool	drawPage (flxDeviceContainer *)
uint8_t	getMenuSelectionYN (uint timeout=kPromptTimeoutValueSec)
int	editSettings (void)
	Called to launch - run - end an edit settings session. More...
Public Member Functions inherited from flxActionType< flxSettingsSerial >
flxTypeID	getType (void)
Public Member Functions inherited from flxAction
virtual bool	initialize (void)
Public Member Functions inherited from flxOperation
virtual flxTypeID	getType (void)
virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...
virtual bool	onSave (flxStorageBlock *stBlk)
virtual bool	onRestore (flxStorageBlock *stBlk)
Public Member Functions inherited from flxObject
	flxObject ()
virtual	~flxObject ()
void	setParent (flxObject *parent)
void	setParent (flxObject &parent)
flxObject *	parent ()
void	setHidden (bool bHide=true)
bool	hidden ()
void	setIsDirty (bool bDirty=true)
bool	isDirty (void)
virtual bool	onSave (flxStorageBlock *stBlk)
virtual bool	save (flxStorage *pStorage)
virtual bool	onRestore (flxStorageBlock *stBlk)
virtual bool	restore (flxStorage *pStorage)
virtual flxTypeID	getType (void)
virtual bool	save (flxStorage *)=0
virtual bool	restore (flxStorage *)=0
Public Member Functions inherited from _flxPropertyContainer
	_flxPropertyContainer ()
void	addProperty (flxProperty *newProperty)
void	addProperty (flxProperty &newProperty)
void	removeProperty (flxProperty *rmProp)
void	removeProperty (flxProperty &rmProp)
flxPropertyList &	getProperties (void)
uint	nProperties (void)
bool	saveProperties (flxStorageBlock *stBlk)
bool	restoreProperties (flxStorageBlock *stBlk)
size_t	propertySaveSize ()
void	hideProperty (flxProperty &theProp)
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...
Public Member Functions inherited from _flxParameterContainer
void	addParameter (flxParameterIn *newParam, bool head=false)
void	addParameter (flxParameterIn &newParam, bool head=false)
void	removeParameter (flxParameterIn *rmParam)
void	removeParameter (flxParameterIn &rmParam)
size_t	nInputParameters ()
void	addParameter (flxParameterOut *newParam, bool head=false)
void	addParameter (flxParameterOut &newParam, bool head=false)
void	removeParameter (flxParameterOut *rmParam)
void	removeParameter (flxParameterOut &rmParam)
size_t	nOutputParameters ()
flxParameterOutList &	getOutputParameters (void)
flxParameterInList &	getInputParameters (void)

Public Attributes
flxPropertyUInt32< flxSettingsSerial >	menuTimeout
flxPropertyBool< flxSettingsSerial >	enableColorOutput = {true}

Protected Member Functions
bool	drawPageParamInVoid (flxOperation *, flxParameterIn *)
int	drawMenu (flxObject *, uint)
int	drawMenu (flxOperation *, uint)
int	drawMenu (flxObjectContainer *, uint)
int	drawMenu (flxOperationContainer *, uint)
int	drawMenu (flxActionContainer *, uint)
int	drawMenu (flxDeviceContainer *, uint)
int	drawMenu (std::vector< std::string > &, uint)
int	selectMenu (flxObject *, uint)
int	selectMenu (flxOperation *, uint)
int	selectMenu (flxObjectContainer *, uint)
int	selectMenu (flxOperationContainer *, uint)
int	selectMenu (flxActionContainer *, uint)
int	selectMenu (flxDeviceContainer *, uint)
uint8_t	getMenuSelection (uint max, uint timeout=kPromptTimeoutValueSec)

Additional Inherited Members
Static Public Member Functions inherited from flxActionType< flxSettingsSerial >
static flxTypeID	type (void)
Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Constructor & Destructor Documentation

flxSettingsSerial()

flxSettingsSerial::flxSettingsSerial ( )

inline

Member Function Documentation

drawMenu() [1/7]

int flxSettingsSerial::drawMenu ( flxActionContainer *  pCurrent, uint  level  )

protected

drawMenu() [2/7]

int flxSettingsSerial::drawMenu ( flxDeviceContainer *  pCurrent, uint  level  )

protected

drawMenu() [3/7]

int flxSettingsSerial::drawMenu ( flxObject *  pCurrent, uint  level  )

protected

drawMenu() [4/7]

int flxSettingsSerial::drawMenu ( flxObjectContainer *  pCurrent, uint  level  )

protected

drawMenu() [5/7]

int flxSettingsSerial::drawMenu ( flxOperation *  pCurrent, uint  level  )

protected

drawMenu() [6/7]

int flxSettingsSerial::drawMenu ( flxOperationContainer *  pCurrent, uint  level  )

protected

drawMenu() [7/7]

int flxSettingsSerial::drawMenu ( std::vector< std::string > &  entries, uint  level  )

protected

drawPage() [1/11]

bool flxSettingsSerial::drawPage

(

flxActionContainer *

pCurrent

)

drawPage() [2/11]

bool flxSettingsSerial::drawPage

(

flxDeviceContainer *

pCurrent

)

drawPage() [3/11]

bool flxSettingsSerial::drawPage

(

flxObject *

pCurrent

)

drawPage() [4/11]

bool flxSettingsSerial::drawPage	(	flxObject *	,
		flxParameterIn *	,
		flxDataLimit *
	)

drawPage() [5/11]

bool flxSettingsSerial::drawPage	(	flxObject *	pCurrent,
		flxProperty *	pProp
	)

drawPage() [6/11]

bool flxSettingsSerial::drawPage	(	flxObject *	,
		flxProperty *	,
		flxDataLimit *
	)

drawPage() [7/11]

bool flxSettingsSerial::drawPage

(

flxObjectContainer *

pCurrent

)

drawPage() [8/11]

bool flxSettingsSerial::drawPage

(

flxOperation *

pCurrent

)

drawPage() [9/11]

bool flxSettingsSerial::drawPage	(	flxOperation *	pCurrent,
		flxParameter *	pParam
	)

drawPage() [10/11]

bool flxSettingsSerial::drawPage	(	flxOperation *	pCurrent,
		flxParameterIn *	pParam
	)

drawPage() [11/11]

bool flxSettingsSerial::drawPage

(

flxOperationContainer *

pCurrent

)

drawPageParamInVoid()

bool flxSettingsSerial::drawPageParamInVoid ( flxOperation *  pCurrent, flxParameterIn *  pParam  )

protected

editSettings()

int flxSettingsSerial::editSettings

(

void

)

Called to launch - run - end an edit settings session.

Return values

-1	Error, 0:Success, 1:Success and Save

getMenuSelection()

uint8_t flxSettingsSerial::getMenuSelection ( uint  max, uint  timeout = kPromptTimeoutValueSec  )

protected

getMenuSelectionYN()

uint8_t flxSettingsSerial::getMenuSelectionYN

(

uint

timeout = kPromptTimeoutValueSec

)

selectMenu() [1/6]

int flxSettingsSerial::selectMenu ( flxActionContainer *  pCurrent, uint  level  )

protected

selectMenu() [2/6]

int flxSettingsSerial::selectMenu ( flxDeviceContainer *  pCurrent, uint  level  )

protected

selectMenu() [3/6]

int flxSettingsSerial::selectMenu ( flxObject *  pCurrent, uint  level  )

protected

selectMenu() [4/6]

int flxSettingsSerial::selectMenu ( flxObjectContainer *  pCurrent, uint  level  )

protected

selectMenu() [5/6]

int flxSettingsSerial::selectMenu ( flxOperation *  pCurrent, uint  level  )

protected

selectMenu() [6/6]

int flxSettingsSerial::selectMenu ( flxOperationContainer *  pCurrent, uint  level  )

protected

setSystemRoot()

void flxSettingsSerial::setSystemRoot ( flxObjectContainer *  theRoot )

inline

Member Data Documentation

enableColorOutput

flxPropertyBool<flxSettingsSerial> flxSettingsSerial::enableColorOutput = {true}

menuTimeout

flxPropertyUInt32<flxSettingsSerial> flxSettingsSerial::menuTimeout

Initial value:

= {
        kPromptTimeoutValueSec,
        {{"30 Seconds", 30}, {"60 Seconds", 60}, {"2 Minutes", 120}, {"5 Minutes", 300}, {"10 Minutes", 600}}}

---

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

• src/core/flux_prefs_serial/flxSettingsSerial.h
• src/core/flux_prefs_serial/flxSettingsSerial.cpp