#include <flxCoreDevice.h>

Inheritance diagram for flxDevice:

Public Member Functions
	flxDevice ()

virtual	~flxDevice ()

virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...

bool	initialize ()

virtual bool	initialize (flxBusI2C &)

virtual bool	initialize (flxBusSPI &)

bool	autoload (void)

void	setAutoload ()

void	setAddress (uint8_t address)

uint8_t	address (void)

void	addAddressToName ()

void	setIsInitialized (bool isInit)

bool	isInitialized (void)

virtual flxDeviceKind_t	getKind (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
flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters >	disableAllParameters

flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters >	enableAllParameters

Additional Inherited Members
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

◆ flxDevice()

flxDevice::flxDevice ( )

inline

◆ ~flxDevice()

virtual flxDevice::~flxDevice ( )

inlinevirtual

Member Function Documentation

◆ addAddressToName()

void flxDevice::addAddressToName ( )

◆ address()

uint8_t flxDevice::address ( void )

inline

◆ autoload()

bool flxDevice::autoload ( void )

inline

◆ execute()

virtual bool flxDevice::execute ( void )

inlinevirtual

Virtual method called to run the operation - called before data is retrieved.

Reimplemented from flxOperation.

Reimplemented in flxDevAS7265X.

◆ getKind()

virtual flxDeviceKind_t flxDevice::getKind ( void )

inlinevirtual

◆ initialize() [1/3]

bool flxDevice::initialize ( void )

◆ initialize() [2/3]

virtual bool flxDevice::initialize ( flxBusI2C & )

inlinevirtual

◆ initialize() [3/3]

virtual bool flxDevice::initialize ( flxBusSPI & )

inlinevirtual

Reimplemented in flxDeviceSPIType< T, B >, flxDeviceSPIType< flxDevISM330_SPI, flxDevISM330Base >, and flxDeviceSPIType< flxDevMMC5983_SPI, flxDevMMC5983Base >.

◆ isInitialized()

bool flxDevice::isInitialized ( void )

inline

◆ setAddress()

void flxDevice::setAddress ( uint8_t address )

inline

◆ setAutoload()

void flxDevice::setAutoload ( )

inline

◆ setIsInitialized()

void flxDevice::setIsInitialized ( bool isInit )

inline

Member Data Documentation

◆ disableAllParameters

flxParameterInVoid<flxDevice, &flxDevice::disable_all_parameters> flxDevice::disableAllParameters

◆ enableAllParameters

flxParameterInVoid<flxDevice, &flxDevice::enable_all_parameters> flxDevice::enableAllParameters

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

src/core/flux_base/flxCoreDevice.h
src/core/flux_base/flxCoreDevice.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ flxDevice()

◆ ~flxDevice()

Member Function Documentation

◆ addAddressToName()

◆ address()

◆ autoload()

◆ execute()

◆ getKind()

◆ initialize() [1/3]

◆ initialize() [2/3]

◆ initialize() [3/3]

◆ isInitialized()

◆ setAddress()

◆ setAutoload()

◆ setIsInitialized()

Member Data Documentation

◆ disableAllParameters

◆ enableAllParameters