flxObject Class Reference

#include <flxCoreProps.h>

Inheritance diagram for flxObject:

Public Member Functions
	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...

Static Public Member Functions
static flxTypeID	type (void)

Additional Inherited Members
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Constructor & Destructor Documentation

flxObject()

flxObject::flxObject ( )

inline

~flxObject()

virtual flxObject::~flxObject ( )

inlinevirtual

Member Function Documentation

getType()

virtual flxTypeID flxObject::getType ( void  )

inlinevirtual

Reimplemented in flxOperation, flxActionType< T >, flxActionType< _flxClock >, flxActionType< flxApplication >, flxActionType< flxFSSDMMCard >, flxActionType< flxFileRotate >, flxActionType< flxIoTArduino >, flxActionType< flxLogger >, flxActionType< flxSetWifiCredentials >, flxActionType< flxSettingsSave >, flxActionType< flxSettingsSerial >, flxActionType< flxSysFirmware >, flxActionType< flxTimer >, flxContainer< T >, flxContainer< flxDevice * >, flxContainer< flxAction * >, flxContainer< flxOperation * >, flxDeviceI2CType< T, B >, flxDeviceI2CType< flxDevACS37800 >, flxDeviceI2CType< flxDevADS1015 >, flxDeviceI2CType< flxDevADS122C04 >, flxDeviceI2CType< flxDevAHT20 >, flxDeviceI2CType< flxDevAMG8833 >, flxDeviceI2CType< flxDevAS7265X >, flxDeviceI2CType< flxDevBME280 >, flxDeviceI2CType< flxDevBME68x >, flxDeviceI2CType< flxDevBMP384 >, flxDeviceI2CType< flxDevBMP581 >, flxDeviceI2CType< flxDevBioHub >, flxDeviceI2CType< flxDevButton >, flxDeviceI2CType< flxDevCCS811 >, flxDeviceI2CType< flxDevENS160 >, flxDeviceI2CType< flxDevFS3000 >, flxDeviceI2CType< flxDevGNSS >, flxDeviceI2CType< flxDevISM330, flxDevISM330Base >, flxDeviceI2CType< flxDevLPS25HB >, flxDeviceI2CType< flxDevMAX17048 >, flxDeviceI2CType< flxDevMCP9600 >, flxDeviceI2CType< flxDevMMC5983, flxDevMMC5983Base >, flxDeviceI2CType< flxDevMS5637 >, flxDeviceI2CType< flxDevMS8607 >, flxDeviceI2CType< flxDevMicroPressure >, flxDeviceI2CType< flxDevNAU7802 >, flxDeviceI2CType< flxDevOPT4048 >, flxDeviceI2CType< flxDevPASCO2V01 >, flxDeviceI2CType< flxDevRV8803 >, flxDeviceI2CType< flxDevSCD30 >, flxDeviceI2CType< flxDevSCD40 >, flxDeviceI2CType< flxDevSDP3X >, flxDeviceI2CType< flxDevSEN54 >, flxDeviceI2CType< flxDevSGP30 >, flxDeviceI2CType< flxDevSGP40 >, flxDeviceI2CType< flxDevSHTC3 >, flxDeviceI2CType< flxDevST25DV >, flxDeviceI2CType< flxDevSTC31 >, flxDeviceI2CType< flxDevSTHS34PF80 >, flxDeviceI2CType< flxDevTMF882X >, flxDeviceI2CType< flxDevTMP117 >, flxDeviceI2CType< flxDevTwist >, flxDeviceI2CType< flxDevVCNL4040 >, flxDeviceI2CType< flxDevVEML6075 >, flxDeviceI2CType< flxDevVEML7700 >, flxDeviceI2CType< flxDevVL53L1X >, flxDeviceI2CType< flxDevVL53L5 >, flxDeviceSPIType< T, B >, flxDeviceSPIType< flxDevISM330_SPI, flxDevISM330Base >, and flxDeviceSPIType< flxDevMMC5983_SPI, flxDevMMC5983Base >.

hidden()

bool flxObject::hidden ( )

inline

isDirty()

bool flxObject::isDirty ( void  )

inline

onRestore()

virtual bool flxObject::onRestore ( flxStorageBlock *  stBlk )

inlinevirtual

Reimplemented in flxOperation.

onSave()

virtual bool flxObject::onSave ( flxStorageBlock *  stBlk )

inlinevirtual

Reimplemented in flxOperation.

parent()

flxObject * flxObject::parent ( )

inline

restore()

virtual bool flxObject::restore ( flxStorage *  pStorage )

inlinevirtual

Implements flxPersist.

Reimplemented in flxContainer< T >, flxContainer< flxDevice * >, flxContainer< flxAction * >, flxContainer< flxOperation * >, and flxFlux.

save()

virtual bool flxObject::save ( flxStorage *  pStorage )

inlinevirtual

Implements flxPersist.

Reimplemented in flxContainer< T >, flxContainer< flxDevice * >, flxContainer< flxAction * >, flxContainer< flxOperation * >, and flxFlux.

setHidden()

void flxObject::setHidden ( bool  bHide = true )

inline

setIsDirty()

void flxObject::setIsDirty ( bool  bDirty = true )

inline

setParent() [1/2]

void flxObject::setParent ( flxObject &  parent )

inline

setParent() [2/2]

void flxObject::setParent ( flxObject *  parent )

inline

type()

static flxTypeID flxObject::type ( void  )

inlinestatic

---

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

• src/core/flux_base/flxCoreProps.h