flxParameterOutScalar Class Reference

#include <flxCoreParam.h>

Inheritance diagram for flxParameterOutScalar:

Public Member Functions
flxParameterOutScalar *	accessor ()
virtual flxDataType_t	type (void)=0
Public Member Functions inherited from flxParameterOut
	flxParameterOut ()
	flxParameterOut (uint8_t flags)
virtual flxDataType_t	type (void)=0
virtual uint16_t	precision (void)
virtual flxParameterOut *	accessor ()=0
uint8_t	flags ()
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...
Public Member Functions inherited from flxDataOut
virtual flxDataType_t	type (void)=0
	Return the type of the data. More...
virtual bool	getBool ()=0
	Get the data as a boolean. More...
virtual int8_t	getInt8 ()=0
	Get the data as an int8_t. More...
virtual int16_t	getInt16 ()=0
	Get the data as an int16_t. More...
virtual int32_t	getInt32 ()=0
	Get the data as an int32_t. More...
virtual uint8_t	getUInt8 ()=0
	Get the data as a uint8_t. More...
virtual uint16_t	getUInt16 ()=0
	Get the data as a uint16_t. More...
virtual uint32_t	getUInt32 ()=0
	Get the data as a uint32_t. More...
virtual float	getFloat ()=0
	Get the data as a float. More...
virtual double	getDouble ()=0
	Get the data as a double. More...
virtual std::string	getString ()=0
	Get the data as a string. More...
bool	get_value (bool b)
	Get the value object as a bool. More...
int8_t	get_value (int8_t)
	Get the value object as an int8_t. More...
int16_t	get_value (int16_t)
	Get the value object as an int16_t. More...
int32_t	get_value (int32_t)
	Get the value object as an int32_t. More...
uint8_t	get_value (uint8_t)
	Get the value object as a uint8_t. More...
uint16_t	get_value (uint16_t)
	Get the value object as a uint16_t. More...
uint32_t	get_value (uint32_t)
	Get the value object as a uint32_t. More...
float	get_value (float)
	Get the value object as a float. More...
double	get_value (double)
	Get the value object as a double. More...
std::string	get_value (std::string)
	Get the value object as a string. More...

Additional Inherited Members
Protected Member Functions inherited from flxParameterOut
void	setFlag (uint8_t flag)
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Member Function Documentation

accessor()

flxParameterOutScalar * flxParameterOutScalar::accessor ( )

inlinevirtual

Implements flxParameterOut.

type()

virtual flxDataType_t flxParameterOutScalar::type ( void  )

pure virtual

Implements flxParameterOut.

Implemented in _flxParameterOut< T, Object, _getter >, _flxParameterOut< double, Object, _getter >, _flxParameterOut< float, Object, _getter >, _flxParameterOut< float, flxDevACS37800, _getter >, _flxParameterOut< flxDevACS37800, &flxDevACS37800::read_pos_angle >, _flxParameterOut< flxDevACS37800, &flxDevACS37800::read_pos_power_factor >, _flxParameterOut< float, flxDevADS1015, _getter >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_single_0 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_single_1 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_single_2 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_single_3 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_differential_P0_N1 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_differential_P0_N3 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_differential_P1_N3 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readi_differential_P2_N3 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readu_single_0 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readu_single_1 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readu_single_2 >, _flxParameterOut< flxDevADS1015, &flxDevADS1015::readu_single_3 >, _flxParameterOut< float, flxDevADS122C04, _getter >, _flxParameterOut< float, flxDevAHT20, _getter >, _flxParameterOut< float, flxDevAMG8833, _getter >, _flxParameterOut< flxDevAS7265X, &flxDevAS7265X::read_output_type >, _flxParameterOut< float, flxDevAS7265X, _getter >, _flxParameterOut< float, flxDevBME280, _getter >, _flxParameterOut< float, flxDevBME68x, _getter >, _flxParameterOut< flxDevBME68x, &flxDevBME68x::read_Status >, _flxParameterOut< double, flxDevBMP384, _getter >, _flxParameterOut< float, flxDevBMP581, _getter >, _flxParameterOut< flxDevBioHub, &flxDevBioHub::read_heart_rate >, _flxParameterOut< flxDevBioHub, &flxDevBioHub::read_confidence >, _flxParameterOut< flxDevBioHub, &flxDevBioHub::read_oxygen >, _flxParameterOut< flxDevBioHub, &flxDevBioHub::read_status >, _flxParameterOut< flxDevBioHub, &flxDevBioHub::read_extended_status >, _flxParameterOut< float, flxDevBioHub, _getter >, _flxParameterOut< flxDevButton, &flxDevButton::read_button_state >, _flxParameterOut< float, flxDevCCS811, _getter >, _flxParameterOut< flxDevENS160, &flxDevENS160::read_AQI >, _flxParameterOut< flxDevENS160, &flxDevENS160::read_TVOC >, _flxParameterOut< flxDevENS160, &flxDevENS160::read_ETOH >, _flxParameterOut< flxDevENS160, &flxDevENS160::read_ECO2 >, _flxParameterOut< float, flxDevENS160, _getter >, _flxParameterOut< float, flxDevFS3000, _getter >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_year >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_month >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_day >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_hour >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_min >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_sec >, _flxParameterOut< double, flxDevGNSS, _getter >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_siv >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_fix >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_carrier_soln >, _flxParameterOut< float, flxDevGNSS, _getter >, _flxParameterOut< flxDevGNSS, &flxDevGNSS::read_tow >, _flxParameterOut< float, flxDevISM330Base, _getter >, _flxParameterOut< float, flxDevLPS25HB, _getter >, _flxParameterOut< float, flxDevMAX17048, _getter >, _flxParameterOut< float, flxDevMCP9600, _getter >, _flxParameterOut< double, flxDevMMC5983Base, _getter >, _flxParameterOut< flxDevMMC5983Base, &flxDevMMC5983Base::read_temperature >, _flxParameterOut< float, flxDevMS5637, _getter >, _flxParameterOut< float, flxDevMS8607, _getter >, _flxParameterOut< float, flxDevMicroPressure, _getter >, _flxParameterOut< float, flxDevNAU7802, _getter >, _flxParameterOut< double, flxDevOPT4048, _getter >, _flxParameterOut< flxDevOPT4048, &flxDevOPT4048::get_lux >, _flxParameterOut< flxDevPASCO2V01, &flxDevPASCO2V01::read_CO2 >, _flxParameterOut< flxDevRV8803, &flxDevRV8803::read_year >, _flxParameterOut< flxDevRV8803, &flxDevRV8803::get_epoch >, _flxParameterOut< flxDevSCD30, &flxDevSCD30::read_CO2 >, _flxParameterOut< float, flxDevSCD30, _getter >, _flxParameterOut< flxDevSCD40, &flxDevSCD40::read_CO2 >, _flxParameterOut< float, flxDevSCD40, _getter >, _flxParameterOut< float, flxDevSDP3X, _getter >, _flxParameterOut< float, flxDevSEN54, _getter >, _flxParameterOut< flxDevSGP30, &flxDevSGP30::read_tvoc >, _flxParameterOut< flxDevSGP30, &flxDevSGP30::read_co2 >, _flxParameterOut< flxDevSGP30, &flxDevSGP30::read_h2 >, _flxParameterOut< flxDevSGP30, &flxDevSGP30::read_ethanol >, _flxParameterOut< flxDevSGP40, &flxDevSGP40::read_voc >, _flxParameterOut< float, flxDevSHTC3, _getter >, _flxParameterOut< float, flxDevSTC31, _getter >, _flxParameterOut< flxDevSTHS34PF80, &flxDevSTHS34PF80::read_Presence >, _flxParameterOut< flxDevSTHS34PF80, &flxDevSTHS34PF80::read_Motion >, _flxParameterOut< float, flxDevSTHS34PF80, _getter >, _flxParameterOut< flxDevTMF882X, &flxDevTMF882X::read_photon_count >, _flxParameterOut< flxDevTMF882X, &flxDevTMF882X::read_ref_photon_count >, _flxParameterOut< flxDevTMF882X, &flxDevTMF882X::read_ambient_light >, _flxParameterOut< double, flxDevTMP117, _getter >, _flxParameterOut< flxDevTwist, &flxDevTwist::read_button_state >, _flxParameterOut< flxDevTwist, &flxDevTwist::get_twist_count >, _flxParameterOut< flxDevVCNL4040, &flxDevVCNL4040::read_proximity >, _flxParameterOut< flxDevVCNL4040, &flxDevVCNL4040::read_lux >, _flxParameterOut< float, flxDevVEML6075, _getter >, _flxParameterOut< flxDevVEML7700, &flxDevVEML7700::read_ambient_light >, _flxParameterOut< flxDevVEML7700, &flxDevVEML7700::read_white_level >, _flxParameterOut< float, flxDevVEML7700, _getter >, _flxParameterOut< flxDevVL53L1X, &flxDevVL53L1X::read_distance >, _flxParameterOut< flxDevVL53L1X, &flxDevVL53L1X::read_range_status >, _flxParameterOut< flxDevVL53L1X, &flxDevVL53L1X::read_signal_rate >, _flxParameterOut< flxLogger, &flxLogger::get_sample_number >, flxParameterOutString< Object, _getter >, flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_iso8601 >, flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_yyyy_mm_dd >, flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_yyyy_dd_mm >, flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_dd_mm_yyyy >, flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_hh_mm_ss >, flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_fix_string >, flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_carrier_soln_string >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_date_USA >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_date >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_time >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_iso8601 >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_iso8601_tz >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_day >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_day_short >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_ordinal >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_month >, flxParameterOutString< flxDevRV8803, &flxDevRV8803::read_month_short >, flxParameterOutString< flxLogger, &flxLogger::get_timestamp >, flxParameterOutString< flxLogger, &flxLogger::get_device_id >, and flxParameterOutString< flxLogger, &flxLogger::get_name >.

---

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

• src/core/flux_base/flxCoreParam.h