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

#include <flxCoreParam.h>

Inheritance diagram for _flxParameterIn< T, Object, _setter >:
flxParameterIn _flxDataIn< T > flxParameter flxDataIn flxDescriptor

Public Member Functions

 _flxParameterIn ()
 
 _flxParameterIn (T min, T max)
 
 _flxParameterIn (std::initializer_list< std::pair< const std::string, T > > limitSet)
 
flxDataType_t type ()
 
void operator() (Object *obj)
 
void operator() (Object *obj, const char *name)
 
void operator() (Object *obj, const char *name, const char *desc)
 
void operator() (Object *obj, const char *name, const char *desc, flxParamValueType_t vtype)
 
void set (T const &value)
 
void operator() (T const &value)
 
flxEditResult_t editValue (flxDataEditor &theEditor)
 
bool setValue (flxDataVariable &value)
 
flxDataLimitdataLimit (void)
 
- Public Member Functions inherited from flxParameterIn
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...
 
- Public Member Functions inherited from _flxDataIn< T >
 _flxDataIn ()
 
flxDataType_t type (void)
 
virtual void set (T const &value)=0
 
void setBool (bool value)
 
void setInt8 (int8_t value)
 
void setInt16 (int16_t value)
 
void setInt32 (int32_t value)
 
void setUInt8 (uint8_t value)
 
void setUInt16 (uint16_t value)
 
void setUInt32 (uint32_t value)
 
void setFloat (float value)
 
void setDouble (double value)
 
void setString (std::string &value)
 
void setDataLimit (flxDataLimitType< T > &dataLimit)
 
void setDataLimit (flxDataLimitType< T > *dataLimit)
 
flxDataLimitdataLimit (void)
 
void setDataLimitRange (T min, T max)
 
void setDataLimitRange (std::pair< T, T > range)
 
void addDataLimitValidValue (std::string name, T value)
 
void addDataLimitValidValue (std::pair< const std::string, T > value)
 
void addDataLimitValidValue (std::initializer_list< std::pair< const std::string, T > > limitSet)
 
void clearDataLimit (void)
 
bool isValueValid (T value)
 
- Public Member Functions inherited from flxDataIn
virtual flxDataType_t type (void)=0
 
virtual void setBool (bool)=0
 
virtual void setInt8 (int8_t)=0
 
virtual void setInt16 (int16_t)=0
 
virtual void setInt32 (int32_t)=0
 
virtual void setUInt8 (uint8_t)=0
 
virtual void setUInt16 (uint16_t)=0
 
virtual void setUInt32 (uint32_t)=0
 
virtual void setFloat (float)=0
 
virtual void setDouble (double)=0
 
virtual void setString (std::string &)=0
 
void set_value (bool v)
 
void set_value (int8_t v)
 
void set_value (int16_t v)
 
void set_value (int32_t v)
 
void set_value (uint8_t v)
 
void set_value (uint16_t v)
 
void set_value (uint32_t v)
 
void set_value (float v)
 
void set_value (double v)
 
void set_value (std::string &v)
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ _flxParameterIn() [1/3]

template<class T , class Object , void(Object::*)(T const &) _setter>
_flxParameterIn< T, Object, _setter >::_flxParameterIn ( )
inline

◆ _flxParameterIn() [2/3]

template<class T , class Object , void(Object::*)(T const &) _setter>
_flxParameterIn< T, Object, _setter >::_flxParameterIn ( min,
max 
)
inline

◆ _flxParameterIn() [3/3]

template<class T , class Object , void(Object::*)(T const &) _setter>
_flxParameterIn< T, Object, _setter >::_flxParameterIn ( std::initializer_list< std::pair< const std::string, T > >  limitSet)
inline

Member Function Documentation

◆ dataLimit()

template<class T , class Object , void(Object::*)(T const &) _setter>
flxDataLimit * _flxParameterIn< T, Object, _setter >::dataLimit ( void  )
inlinevirtual

Implements flxParameterIn.

◆ editValue()

template<class T , class Object , void(Object::*)(T const &) _setter>
flxEditResult_t _flxParameterIn< T, Object, _setter >::editValue ( flxDataEditor theEditor)
inlinevirtual

Implements flxParameterIn.

◆ operator()() [1/5]

template<class T , class Object , void(Object::*)(T const &) _setter>
void _flxParameterIn< T, Object, _setter >::operator() ( Object *  obj)
inline

◆ operator()() [2/5]

template<class T , class Object , void(Object::*)(T const &) _setter>
void _flxParameterIn< T, Object, _setter >::operator() ( Object *  obj,
const char *  name 
)
inline

◆ operator()() [3/5]

template<class T , class Object , void(Object::*)(T const &) _setter>
void _flxParameterIn< T, Object, _setter >::operator() ( Object *  obj,
const char *  name,
const char *  desc 
)
inline

◆ operator()() [4/5]

template<class T , class Object , void(Object::*)(T const &) _setter>
void _flxParameterIn< T, Object, _setter >::operator() ( Object *  obj,
const char *  name,
const char *  desc,
flxParamValueType_t  vtype 
)
inline

◆ operator()() [5/5]

template<class T , class Object , void(Object::*)(T const &) _setter>
void _flxParameterIn< T, Object, _setter >::operator() ( T const &  value)
inline

◆ set()

template<class T , class Object , void(Object::*)(T const &) _setter>
void _flxParameterIn< T, Object, _setter >::set ( T const &  value)
inlinevirtual

Implements _flxDataIn< T >.

◆ setValue()

template<class T , class Object , void(Object::*)(T const &) _setter>
bool _flxParameterIn< T, Object, _setter >::setValue ( flxDataVariable value)
inlinevirtual

Implements flxParameterIn.

◆ type()

template<class T , class Object , void(Object::*)(T const &) _setter>
flxDataType_t _flxParameterIn< T, Object, _setter >::type ( void  )
inlinevirtual

Implements flxParameter.


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