flux sdk  v01.02.02-3-g292b3a7
Embedded C++ SDK
Loading...
Searching...
No Matches
flxDeviceSPIType< T, B > Class Template Reference

#include <flxDevice.h>

Inheritance diagram for flxDeviceSPIType< T, B >:
flxDevice flxOperation flxObject _flxParameterContainer flxPersist _flxPropertyContainer flxDescriptor

Public Member Functions

bool initialize (SPIClass &spiPort)
 
bool initialize (flxBusSPI &spiDriver)
 
bool initialize (void)
 
bool initialize (uint8_t cs)
 
virtual bool onInitialize (SPIClass &)
 
void setChipSelect (uint8_t cs)
 
uint8_t chipSelect (void)
 
flxTypeID getType (void)
 
bool isType (flxTypeID type)
 
flxDeviceKind_t getKind (void)
 
- Public Member Functions inherited from flxDevice
 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)
 
flxObjectparent ()
 
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)
 
flxPropertyListgetProperties (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 ()
 
flxParameterOutListgetOutputParameters (void)
 
flxParameterInListgetInputParameters (void)
 

Static Public Member Functions

static flxTypeID type (void)
 
static flxDeviceKind_t kind (void)
 
- Static Public Member Functions inherited from flxObject
static flxTypeID type (void)
 

Additional Inherited Members

- Public Attributes inherited from flxDevice
flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters > disableAllParameters
 
flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters > enableAllParameters
 
- Protected Attributes inherited from flxDescriptor
const char * _name
 
bool _nameAlloc
 
const char * _desc
 
bool _descAlloc
 
const char * _title
 
bool _titleAlloc
 

Member Function Documentation

◆ chipSelect()

template<typename T , typename B = flxDevice>
uint8_t flxDeviceSPIType< T, B >::chipSelect ( void  )
inline

◆ getKind()

template<typename T , typename B = flxDevice>
flxDeviceKind_t flxDeviceSPIType< T, B >::getKind ( void  )
inlinevirtual

Reimplemented from flxDevice.

◆ getType()

template<typename T , typename B = flxDevice>
flxTypeID flxDeviceSPIType< T, B >::getType ( void  )
inlinevirtual

Reimplemented from flxOperation.

◆ initialize() [1/4]

template<typename T , typename B = flxDevice>
bool flxDeviceSPIType< T, B >::initialize ( flxBusSPI spiDriver)
inlinevirtual

Reimplemented from flxDevice.

◆ initialize() [2/4]

template<typename T , typename B = flxDevice>
bool flxDeviceSPIType< T, B >::initialize ( SPIClass &  spiPort)
inline

◆ initialize() [3/4]

template<typename T , typename B = flxDevice>
bool flxDeviceSPIType< T, B >::initialize ( uint8_t  cs)
inline

◆ initialize() [4/4]

template<typename T , typename B = flxDevice>
bool flxDeviceSPIType< T, B >::initialize ( void  )
inline

◆ isType()

template<typename T , typename B = flxDevice>
bool flxDeviceSPIType< T, B >::isType ( flxTypeID  type)
inline

◆ kind()

template<typename T , typename B = flxDevice>
static flxDeviceKind_t flxDeviceSPIType< T, B >::kind ( void  )
inlinestatic

◆ onInitialize()

template<typename T , typename B = flxDevice>
virtual bool flxDeviceSPIType< T, B >::onInitialize ( SPIClass &  )
inlinevirtual

Reimplemented in flxDevISM330_SPI, and flxDevMMC5983_SPI.

◆ setChipSelect()

template<typename T , typename B = flxDevice>
void flxDeviceSPIType< T, B >::setChipSelect ( uint8_t  cs)
inline

◆ type()

template<typename T , typename B = flxDevice>
static flxTypeID flxDeviceSPIType< T, B >::type ( void  )
inlinestatic

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