flux sdk  v01.02.02-3-g292b3a7
Embedded C++ SDK
Loading...
Searching...
No Matches
flxParameterIn Class Referenceabstract

#include <flxCoreParam.h>

Inheritance diagram for flxParameterIn:
flxParameter flxDescriptor _flxParameterIn< flxDevNAU7802, &flxDevNAU7802::calculate_calibration_factor > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_epoch > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_seconds > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_minutes > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_hours > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_date > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_weekday > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_month > _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_year > _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_rh > _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_temperature > _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_rh > _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_temperature > _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_pressure > _flxParameterIn< flxLogger, &flxLogger::reset_sample_number > _flxParameterIn< T, Object, _setter > flxParameterInString< Object, _setter > flxParameterInVoidType

Public Member Functions

virtual flxEditResult_t editValue (flxDataEditor &)=0
 
virtual bool setValue (flxDataVariable &)=0
 
virtual flxDataLimitdataLimit (void)=0
 
std::string to_string ()
 
- Public Member Functions inherited from flxParameter
 flxParameter ()
 
bool enabled (void)
 
flxParamValueType_t valueType (void)
 
void setValueType (flxParamValueType_t type)
 
virtual void setEnabled (bool enabled)
 
virtual flxDataType_t type (void)=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...
 

Additional Inherited Members

- Protected Attributes inherited from flxDescriptor
const char * _name
 
bool _nameAlloc
 
const char * _desc
 
bool _descAlloc
 
const char * _title
 
bool _titleAlloc
 

Member Function Documentation

◆ dataLimit()

virtual flxDataLimit * flxParameterIn::dataLimit ( void  )
pure virtual

Implemented in _flxParameterIn< T, Object, _setter >, _flxParameterIn< flxDevNAU7802, &flxDevNAU7802::calculate_calibration_factor >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_epoch >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_seconds >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_minutes >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_hours >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_date >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_weekday >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_month >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_year >, _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_rh >, _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_temperature >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_rh >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_temperature >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_pressure >, _flxParameterIn< flxLogger, &flxLogger::reset_sample_number >, flxParameterInString< Object, _setter >, flxParameterInVoid< Object, _setter >, flxParameterInVoid< flxDevGNSS, &flxDevGNSS::factory_default >, flxParameterInVoid< flxDevNAU7802, &flxDevNAU7802::calculate_zero_offset >, flxParameterInVoid< flxDevTMF882X, &flxDevTMF882X::factory_calibration >, flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters >, flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_settings >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_settings >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::reset >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_fallback >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_fallback >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::restartDevicePrompt >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::factory_reset >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::update_firmware_SD >, and flxParameterInVoid< flxSysFirmware, &flxSysFirmware::update_firmware_OTA >.

◆ editValue()

virtual flxEditResult_t flxParameterIn::editValue ( flxDataEditor )
pure virtual

Implemented in _flxParameterIn< T, Object, _setter >, _flxParameterIn< flxDevNAU7802, &flxDevNAU7802::calculate_calibration_factor >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_epoch >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_seconds >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_minutes >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_hours >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_date >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_weekday >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_month >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_year >, _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_rh >, _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_temperature >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_rh >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_temperature >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_pressure >, _flxParameterIn< flxLogger, &flxLogger::reset_sample_number >, flxParameterInString< Object, _setter >, flxParameterInVoid< Object, _setter >, flxParameterInVoid< flxDevGNSS, &flxDevGNSS::factory_default >, flxParameterInVoid< flxDevNAU7802, &flxDevNAU7802::calculate_zero_offset >, flxParameterInVoid< flxDevTMF882X, &flxDevTMF882X::factory_calibration >, flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters >, flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_settings >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_settings >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::reset >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_fallback >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_fallback >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::restartDevicePrompt >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::factory_reset >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::update_firmware_SD >, and flxParameterInVoid< flxSysFirmware, &flxSysFirmware::update_firmware_OTA >.

◆ setValue()

virtual bool flxParameterIn::setValue ( flxDataVariable )
pure virtual

Implemented in _flxParameterIn< T, Object, _setter >, _flxParameterIn< flxDevNAU7802, &flxDevNAU7802::calculate_calibration_factor >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_epoch >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_seconds >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_minutes >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_hours >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_date >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_weekday >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_month >, _flxParameterIn< flxDevRV8803, &flxDevRV8803::set_year >, _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_rh >, _flxParameterIn< flxDevSGP40, &flxDevSGP40::write_temperature >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_rh >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_temperature >, _flxParameterIn< flxDevSTC31, &flxDevSTC31::write_pressure >, _flxParameterIn< flxLogger, &flxLogger::reset_sample_number >, flxParameterInString< Object, _setter >, flxParameterInVoid< Object, _setter >, flxParameterInVoid< flxDevGNSS, &flxDevGNSS::factory_default >, flxParameterInVoid< flxDevNAU7802, &flxDevNAU7802::calculate_zero_offset >, flxParameterInVoid< flxDevTMF882X, &flxDevTMF882X::factory_calibration >, flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters >, flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_settings >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_settings >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::reset >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_fallback >, flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_fallback >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::restartDevicePrompt >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::factory_reset >, flxParameterInVoid< flxSysFirmware, &flxSysFirmware::update_firmware_SD >, and flxParameterInVoid< flxSysFirmware, &flxSysFirmware::update_firmware_OTA >.

◆ to_string()

std::string flxParameterIn::to_string ( )
inline

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