flux sdk  v01.02.02-3-g292b3a7
Embedded C++ SDK
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
_flxPropertyBaseString< HIDDEN, SECURE > Class Template Referenceabstract

#include <flxCoreProps.h>

Inheritance diagram for _flxPropertyBaseString< HIDDEN, SECURE >:
flxProperty _flxDataInString _flxDataOutString flxDescriptor flxPropertyRWString< _flxClock, &_flxClock::get_ref_clock, &_flxClock::set_ref_clock > flxPropertyRWString< _flxClock, &_flxClock::get_timezone, &_flxClock::set_timezone > flxPropertyRWString< flxDevST25DV, &flxDevST25DV::get_ssid, &flxDevST25DV::set_ssid > flxPropertyRWString< flxDevST25DV, &flxDevST25DV::get_password, &flxDevST25DV::set_password > flxPropertyRWString< flxIoTArduino, &flxIoTArduino::get_thingName, &flxIoTArduino::set_thingName > flxPropertyRWString< flxIoTArduino, &flxIoTArduino::get_thingID, &flxIoTArduino::set_thingID > flxPropertyRWString< flxIoTThingSpeak, &flxIoTThingSpeak::get_channelList, &flxIoTThingSpeak::set_channelList > flxPropertyString< flxFileRotate > flxPropertyString< flxIoTArduino > flxPropertyString< flxIoTAzure > flxPropertyString< flxSysFirmware > flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE > flxPropertyString< Object, HIDDEN, SECURE >

Public Member Functions

 _flxPropertyBaseString ()
 
bool hidden ()
 
void setHidden (void)
 
bool secure ()
 
flxDataType_t type ()
 
size_t size ()
 
size_t save_size ()
 
virtual std::string get (void) const =0
 
virtual void set (const std::string &value)=0
 
void set (const char *value)
 
std::string to_string ()
 
bool save (flxStorageBlock *stBlk)
 
bool restore (flxStorageBlock *stBlk)
 
flxEditResult_t editValue (flxDataEditor &theEditor)
 
void setDataLimit (flxDataLimitType< std::string > &dataLimit)
 
flxDataLimit * dataLimit (void)
 
bool setValue (flxDataVariable &value)
 
flxDataVariable getValue (void)
 
virtual flxDataType_t type (void)=0
 
virtual flxEditResult_t editValue (flxDataEditor &)=0
 
virtual flxDataLimit * dataLimit (void)=0
 
virtual bool setValue (flxDataVariable &)=0
 
virtual flxDataVariable getValue (void)=0
 
virtual bool hidden (void)=0
 
virtual void setHidden (void)=0
 
virtual bool secure (void)=0
 
virtual size_t size (void)
 
virtual size_t save_size (void)
 
virtual std::string to_string ()
 
virtual bool save (flxStorageBlock *)=0
 
virtual bool restore (flxStorageBlock *)=0
 
- 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...
 

Protected Attributes

flxDataLimitType< std::string > * _dataLimit
 
- Protected Attributes inherited from flxDescriptor
const char * _name
 
bool _nameAlloc
 
const char * _desc
 
bool _descAlloc
 
const char * _title
 
bool _titleAlloc
 

Constructor & Destructor Documentation

◆ _flxPropertyBaseString()

template<bool HIDDEN, bool SECURE>
_flxPropertyBaseString< HIDDEN, SECURE >::_flxPropertyBaseString ( )
inline

Member Function Documentation

◆ dataLimit()

template<bool HIDDEN, bool SECURE>
flxDataLimit * _flxPropertyBaseString< HIDDEN, SECURE >::dataLimit ( void  )
inlinevirtual

Implements flxProperty.

◆ editValue()

template<bool HIDDEN, bool SECURE>
flxEditResult_t _flxPropertyBaseString< HIDDEN, SECURE >::editValue ( flxDataEditor &  theEditor)
inlinevirtual

Implements flxProperty.

◆ get()

template<bool HIDDEN, bool SECURE>
virtual std::string _flxPropertyBaseString< HIDDEN, SECURE >::get ( void  ) const
pure virtual

Implements _flxDataOutString.

Implemented in flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >, flxPropertyRWString< _flxClock, &_flxClock::get_ref_clock, &_flxClock::set_ref_clock >, flxPropertyRWString< _flxClock, &_flxClock::get_timezone, &_flxClock::set_timezone >, flxPropertyRWString< flxDevST25DV, &flxDevST25DV::get_ssid, &flxDevST25DV::set_ssid >, flxPropertyRWString< flxDevST25DV, &flxDevST25DV::get_password, &flxDevST25DV::set_password >, flxPropertyRWString< flxIoTArduino, &flxIoTArduino::get_thingName, &flxIoTArduino::set_thingName >, flxPropertyRWString< flxIoTArduino, &flxIoTArduino::get_thingID, &flxIoTArduino::set_thingID >, flxPropertyRWString< flxIoTThingSpeak, &flxIoTThingSpeak::get_channelList, &flxIoTThingSpeak::set_channelList >, flxPropertyString< Object, HIDDEN, SECURE >, flxPropertyString< flxFileRotate >, flxPropertyString< flxIoTArduino >, flxPropertyString< flxIoTAzure >, and flxPropertyString< flxSysFirmware >.

◆ getValue()

template<bool HIDDEN, bool SECURE>
flxDataVariable _flxPropertyBaseString< HIDDEN, SECURE >::getValue ( void  )
inlinevirtual

Implements flxProperty.

◆ hidden()

template<bool HIDDEN, bool SECURE>
bool _flxPropertyBaseString< HIDDEN, SECURE >::hidden ( void  )
inlinevirtual

Implements flxProperty.

◆ restore()

template<bool HIDDEN, bool SECURE>
bool _flxPropertyBaseString< HIDDEN, SECURE >::restore ( flxStorageBlock *  stBlk)
inlinevirtual

Implements flxProperty.

◆ save()

template<bool HIDDEN, bool SECURE>
bool _flxPropertyBaseString< HIDDEN, SECURE >::save ( flxStorageBlock *  stBlk)
inlinevirtual

Implements flxProperty.

◆ save_size()

template<bool HIDDEN, bool SECURE>
size_t _flxPropertyBaseString< HIDDEN, SECURE >::save_size ( void  )
inlinevirtual

Reimplemented from flxProperty.

◆ secure()

template<bool HIDDEN, bool SECURE>
bool _flxPropertyBaseString< HIDDEN, SECURE >::secure ( void  )
inlinevirtual

Implements flxProperty.

◆ set() [1/2]

template<bool HIDDEN, bool SECURE>
void _flxPropertyBaseString< HIDDEN, SECURE >::set ( const char *  value)
inlinevirtual

Reimplemented from _flxDataInString.

◆ set() [2/2]

template<bool HIDDEN, bool SECURE>
virtual void _flxPropertyBaseString< HIDDEN, SECURE >::set ( const std::string &  value)
pure virtual

Implements _flxDataInString.

Implemented in flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >, flxPropertyRWString< _flxClock, &_flxClock::get_ref_clock, &_flxClock::set_ref_clock >, flxPropertyRWString< _flxClock, &_flxClock::get_timezone, &_flxClock::set_timezone >, flxPropertyRWString< flxDevST25DV, &flxDevST25DV::get_ssid, &flxDevST25DV::set_ssid >, flxPropertyRWString< flxDevST25DV, &flxDevST25DV::get_password, &flxDevST25DV::set_password >, flxPropertyRWString< flxIoTArduino, &flxIoTArduino::get_thingName, &flxIoTArduino::set_thingName >, flxPropertyRWString< flxIoTArduino, &flxIoTArduino::get_thingID, &flxIoTArduino::set_thingID >, flxPropertyRWString< flxIoTThingSpeak, &flxIoTThingSpeak::get_channelList, &flxIoTThingSpeak::set_channelList >, flxPropertyString< Object, HIDDEN, SECURE >, flxPropertyString< flxFileRotate >, flxPropertyString< flxIoTArduino >, flxPropertyString< flxIoTAzure >, and flxPropertyString< flxSysFirmware >.

◆ setDataLimit()

template<bool HIDDEN, bool SECURE>
void _flxPropertyBaseString< HIDDEN, SECURE >::setDataLimit ( flxDataLimitType< std::string > &  dataLimit)
inline

◆ setHidden()

template<bool HIDDEN, bool SECURE>
void _flxPropertyBaseString< HIDDEN, SECURE >::setHidden ( void  )
inlinevirtual

Implements flxProperty.

◆ setValue()

template<bool HIDDEN, bool SECURE>
bool _flxPropertyBaseString< HIDDEN, SECURE >::setValue ( flxDataVariable &  value)
inlinevirtual

Implements flxProperty.

◆ size()

template<bool HIDDEN, bool SECURE>
size_t _flxPropertyBaseString< HIDDEN, SECURE >::size ( void  )
inlinevirtual

Reimplemented from flxProperty.

◆ to_string()

template<bool HIDDEN, bool SECURE>
std::string _flxPropertyBaseString< HIDDEN, SECURE >::to_string ( void  )
inlinevirtual

Reimplemented from flxProperty.

◆ type()

template<bool HIDDEN, bool SECURE>
flxDataType_t _flxPropertyBaseString< HIDDEN, SECURE >::type ( void  )
inlinevirtual

Implements flxProperty.

Member Data Documentation

◆ _dataLimit

template<bool HIDDEN, bool SECURE>
flxDataLimitType<std::string>* _flxPropertyBaseString< HIDDEN, SECURE >::_dataLimit
protected
The documentation for this class was generated from the following file: