flux sdk  v01.02.02-3-g292b3a7
Embedded C++ SDK
Loading...
Searching...
No Matches
flxCoreProps.h File Reference

Defines the objects that make up the property system in the framework. More...

#include <string>
#include <vector>
#include "flxCoreInterface.h"
#include "flxCoreTypes.h"
#include "flxStorage.h"
#include "flxUtils.h"

Classes

class  flxProperty
 
class  _flxPropertyContainer
 
class  _flxPropertyBase< T, HIDDEN, SECURE >
 A core template to define a property object that implements a typed value that sets/gets an attribute value of a objects property More...
 
class  _flxPropertyBaseString< HIDDEN, SECURE >
 
class  _flxPropertyTypedRW< T, Object, _getter, _setter, HIDDEN, SECURE >
 
class  flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >
 A string read/write property object that takes a getter and a setter method and the target object. More...
 
class  _flxPropertyTyped< Object, T, HIDDEN, SECURE >
 
class  flxPropertyString< Object, HIDDEN, SECURE >
 
class  flxObject
 
class  flxContainer< T >
 

Macros

#define kMaxPropertyString   256
 

Typedefs

using flxPropertyList = std::vector< flxProperty * >
 Define a property list type - vector of properties. More...
 
template<class Object , bool(Object::*)() _getter, void(Object::*)(bool) _setter>
using flxPropertyRWBool = _flxPropertyTypedRW< bool, Object, _getter, _setter >
 A boolean property object that calls provided methods to set/get the property value. More...
 
template<class Object , int8_t(Object::*)() _getter, void(Object::*)(int8_t) _setter>
using flxPropertyRWInt8 = _flxPropertyTypedRW< int8_t, Object, _getter, _setter >
 A int8_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int16_t(Object::*)() _getter, void(Object::*)(int16_t) _setter>
using flxPropertyRWInt16 = _flxPropertyTypedRW< int16_t, Object, _getter, _setter >
 A int16_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int32_t(Object::*)() _getter, void(Object::*)(int32_t) _setter>
using flxPropertyRWInt32 = _flxPropertyTypedRW< int32_t, Object, _getter, _setter >
 A int32_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint8_t(Object::*)() _getter, void(Object::*)(uint8_t) _setter>
using flxPropertyRWUInt8 = _flxPropertyTypedRW< uint8_t, Object, _getter, _setter >
 A uint8_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint16_t(Object::*)() _getter, void(Object::*)(uint16_t) _setter>
using flxPropertyRWUInt16 = _flxPropertyTypedRW< uint16_t, Object, _getter, _setter >
 A uint16_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint32_t(Object::*)() _getter, void(Object::*)(uint32_t) _setter>
using flxPropertyRWUInt32 = _flxPropertyTypedRW< uint32_t, Object, _getter, _setter >
 A uint32_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , float(Object::*)() _getter, void(Object::*)(float) _setter>
using flxPropertyRWFloat = _flxPropertyTypedRW< float, Object, _getter, _setter >
 A float read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , double(Object::*)() _getter, void(Object::*)(double) _setter>
using flxPropertyRWDouble = _flxPropertyTypedRW< double, Object, _getter, _setter >
 A double read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , bool(Object::*)() _getter, void(Object::*)(bool) _setter>
using flxPropertyRWHiddenBool = _flxPropertyTypedRW< bool, Object, _getter, _setter, true >
 A HIDDEN boolean read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int8_t(Object::*)() _getter, void(Object::*)(int8_t) _setter>
using flxPropertyRWHiddenInt8 = _flxPropertyTypedRW< int8_t, Object, _getter, _setter, true >
 A HIDDEN int8_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int16_t(Object::*)() _getter, void(Object::*)(int16_t) _setter>
using flxPropertyRWHiddenInt16 = _flxPropertyTypedRW< int16_t, Object, _getter, _setter, true >
 A HIDDEN int16_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int32_t(Object::*)() _getter, void(Object::*)(int32_t) _setter>
using flxPropertyRWHiddenInt32 = _flxPropertyTypedRW< int32_t, Object, _getter, _setter, true >
 A HIDDEN int32_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint8_t(Object::*)() _getter, void(Object::*)(uint8_t) _setter>
using flxPropertyRWHiddenUInt8 = _flxPropertyTypedRW< uint8_t, Object, _getter, _setter, true >
 A HIDDEN uint8_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint16_t(Object::*)() _getter, void(Object::*)(uint16_t) _setter>
using flxPropertyRWHiddenUInt16 = _flxPropertyTypedRW< uint16_t, Object, _getter, _setter, true >
 A HIDDEN uint16_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint32_t(Object::*)() _getter, void(Object::*)(uint32_t) _setter>
using flxPropertyRWHiddenUInt32 = _flxPropertyTypedRW< uint32_t, Object, _getter, _setter, true >
 A HIDDEN uint32_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , float(Object::*)() _getter, void(Object::*)(float) _setter>
using flxPropertyRWHiddenFloat = _flxPropertyTypedRW< float, Object, _getter, _setter, true >
 A HIDDEN float read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , double(Object::*)() _getter, void(Object::*)(double) _setter>
using flxPropertyRWHiddenDouble = _flxPropertyTypedRW< double, Object, _getter, _setter, true >
 A HIDDEN double read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , bool(Object::*)() _getter, void(Object::*)(bool) _setter>
using flxPropertyRWSecureBool = _flxPropertyTypedRW< bool, Object, _getter, _setter, false, true >
 A SECURE bool read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , int8_t(Object::*)() _getter, void(Object::*)(int8_t) _setter>
using flxPropertyRWSecureInt8 = _flxPropertyTypedRW< int8_t, Object, _getter, _setter, false, true >
 A SECURE int8_t read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , int16_t(Object::*)() _getter, void(Object::*)(int16_t) _setter>
using flxPropertyRWSecureInt16 = _flxPropertyTypedRW< int16_t, Object, _getter, _setter, false, true >
 A SECURE int16_t read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , int32_t(Object::*)() _getter, void(Object::*)(int32_t) _setter>
using flxPropertyRWSecureInt32 = _flxPropertyTypedRW< int32_t, Object, _getter, _setter, false, true >
 A SECURE int32_t read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , uint8_t(Object::*)() _getter, void(Object::*)(uint8_t) _setter>
using flxPropertyRWSecureUInt8 = _flxPropertyTypedRW< uint8_t, Object, _getter, _setter, false, true >
 A SECURE uint8_t read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , uint16_t(Object::*)() _getter, void(Object::*)(uint16_t) _setter>
using flxPropertyRWSecureUInt16 = _flxPropertyTypedRW< uint16_t, Object, _getter, _setter, false, true >
 A SECURE uint16_t read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , uint32_t(Object::*)() _getter, void(Object::*)(uint32_t) _setter>
using flxPropertyRWSecureUInt32 = _flxPropertyTypedRW< uint32_t, Object, _getter, _setter, false, true >
 A SECURE uint32_t read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , float(Object::*)() _getter, void(Object::*)(float) _setter>
using flxPropertyRWSecureFloat = _flxPropertyTypedRW< float, Object, _getter, _setter, false, true >
 A SECURE float read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , double(Object::*)() _getter, void(Object::*)(double) _setter>
using flxPropertyRWSecureDouble = _flxPropertyTypedRW< double, Object, _getter, _setter, false, true >
 A SECURE double read/write property object that takes a getter and a setter method and the target. More...
 
template<class Object , bool(Object::*)() _getter, void(Object::*)(bool) _setter>
using flxPropertyRWSecretBool = _flxPropertyTypedRW< bool, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE bool read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int8_t(Object::*)() _getter, void(Object::*)(int8_t) _setter>
using flxPropertyRWSecretInt8 = _flxPropertyTypedRW< int8_t, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE int8_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int16_t(Object::*)() _getter, void(Object::*)(int16_t) _setter>
using flxPropertyRWSecretInt16 = _flxPropertyTypedRW< int16_t, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE int16_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , int32_t(Object::*)() _getter, void(Object::*)(int32_t) _setter>
using flxPropertyRWSecretInt32 = _flxPropertyTypedRW< int32_t, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE int32_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint8_t(Object::*)() _getter, void(Object::*)(uint8_t) _setter>
using flxPropertyRWSecretUInt8 = _flxPropertyTypedRW< uint8_t, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE uint8_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint16_t(Object::*)() _getter, void(Object::*)(uint16_t) _setter>
using flxPropertyRWSecretUInt16 = _flxPropertyTypedRW< uint16_t, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE uint16_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , uint32_t(Object::*)() _getter, void(Object::*)(uint32_t) _setter>
using flxPropertyRWSecretUInt32 = _flxPropertyTypedRW< uint32_t, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE uint32_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , float(Object::*)() _getter, void(Object::*)(float) _setter>
using flxPropertyRWSecretFloat = _flxPropertyTypedRW< float, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE float read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , double(Object::*)() _getter, void(Object::*)(double) _setter>
using flxPropertyRWSecretDouble = _flxPropertyTypedRW< double, Object, _getter, _setter, true, true >
 A HIDDEN and SECURE double read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter>
using flxPropertyRWHiddenString = flxPropertyRWString< Object, _getter, _setter, true, false >
 A HIDDEN uint8_t read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter>
using flxPropertyRWSecureString = flxPropertyRWString< Object, _getter, _setter, false, true >
 A SECURE string read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter>
using flxPropertyRWSecretString = flxPropertyRWString< Object, _getter, _setter, true, true >
 A HIDDEN and SECURE string read/write property object that takes a getter and a setter method and the target object. More...
 
template<class Object >
using flxPropertyBool = _flxPropertyTyped< Object, bool >
 A boolean property object. More...
 
template<class Object >
using flxPropertyInt8 = _flxPropertyTyped< Object, int8_t >
 A int8_t property object. More...
 
template<class Object >
using flxPropertyInt16 = _flxPropertyTyped< Object, int16_t >
 A int16_t property object. More...
 
template<class Object >
using flxPropertyInt32 = _flxPropertyTyped< Object, int32_t >
 A int32_t property object. More...
 
template<class Object >
using flxPropertyUInt8 = _flxPropertyTyped< Object, uint8_t >
 A uint8_t property object. More...
 
template<class Object >
using flxPropertyUInt16 = _flxPropertyTyped< Object, uint16_t >
 A uint16_t property object. More...
 
template<class Object >
using flxPropertyUInt32 = _flxPropertyTyped< Object, uint32_t >
 A uint32_t property object. More...
 
template<class Object >
using flxPropertyFloat = _flxPropertyTyped< Object, float >
 A float property object. More...
 
template<class Object >
using flxPropertyDouble = _flxPropertyTyped< Object, double >
 A double property object. More...
 
template<class Object >
using flxPropertyHiddenBool = _flxPropertyTyped< Object, bool, true >
 
template<class Object >
using flxPropertyHiddenInt8 = _flxPropertyTyped< Object, int8_t, true >
 
template<class Object >
using flxPropertyHiddenInt16 = _flxPropertyTyped< Object, int16_t, true >
 
template<class Object >
using flxPropertyHiddenInt32 = _flxPropertyTyped< Object, int32_t, true >
 
template<class Object >
using flxPropertyHiddenUInt8 = _flxPropertyTyped< Object, uint8_t, true >
 
template<class Object >
using flxPropertyHiddenUInt16 = _flxPropertyTyped< Object, uint16_t, true >
 
template<class Object >
using flxPropertyHiddenUInt32 = _flxPropertyTyped< Object, uint32_t, true >
 
template<class Object >
using flxPropertyHiddenFloat = _flxPropertyTyped< Object, float, true >
 
template<class Object >
using flxPropertyHiddenDouble = _flxPropertyTyped< Object, double, true >
 
template<class Object >
using flxPropertySecureBool = _flxPropertyTyped< Object, bool, false, true >
 
template<class Object >
using flxPropertySecureInt8 = _flxPropertyTyped< Object, int8_t, false, true >
 
template<class Object >
using flxPropertySecureInt16 = _flxPropertyTyped< Object, int16_t, false, true >
 
template<class Object >
using flxPropertySecureInt32 = _flxPropertyTyped< Object, int32_t, false, true >
 
template<class Object >
using flxPropertySecureUInt8 = _flxPropertyTyped< Object, uint8_t, false, true >
 
template<class Object >
using flxPropertySecureUInt16 = _flxPropertyTyped< Object, uint16_t, false, true >
 
template<class Object >
using flxPropertySecureUInt32 = _flxPropertyTyped< Object, uint32_t, false, true >
 
template<class Object >
using flxPropertySecureFloat = _flxPropertyTyped< Object, float, false, true >
 
template<class Object >
using flxPropertySecureDouble = _flxPropertyTyped< Object, double, false, true >
 
template<class Object >
using flxPropertySecretBool = _flxPropertyTyped< Object, bool, true, true >
 
template<class Object >
using flxPropertySecretInt8 = _flxPropertyTyped< Object, int8_t, true, true >
 
template<class Object >
using flxPropertySecretInt16 = _flxPropertyTyped< Object, int16_t, true, true >
 
template<class Object >
using flxPropertySecretInt32 = _flxPropertyTyped< Object, int32_t, true, true >
 
template<class Object >
using flxPropertySecretUInt8 = _flxPropertyTyped< Object, uint8_t, true, true >
 
template<class Object >
using flxPropertySecretUInt16 = _flxPropertyTyped< Object, uint16_t, true, true >
 
template<class Object >
using flxPropertySecretUInt32 = _flxPropertyTyped< Object, uint32_t, true, true >
 
template<class Object >
using flxPropertySecretFloat = _flxPropertyTyped< Object, float, true, true >
 
template<class Object >
using flxPropertySecretDouble = _flxPropertyTyped< Object, double, true, true >
 
template<class Object >
using flxPropertyHiddenString = flxPropertyString< Object, true, false >
 
template<class Object >
using flxPropertySecureString = flxPropertyString< Object, false, true >
 
template<class Object >
using flxPropertySecretString = flxPropertyString< Object, true, true >
 
using flxObjectContainer = flxContainer< flxObject * >
 

Enumerations

enum  flxEditResult_t { flxEditSuccess = 0 , flxEditFailure , flxEditOutOfRange }
 

Functions

template<class T >
bool flxIsType (flxObject *pObj)
 

Detailed Description

Defines the objects that make up the property system in the framework.

Note

Macro Definition Documentation

◆ kMaxPropertyString

#define kMaxPropertyString   256

Typedef Documentation

◆ flxObjectContainer

◆ flxPropertyHiddenString

template<class Object >
using flxPropertyHiddenString = flxPropertyString<Object, true, false>

◆ flxPropertyList

using flxPropertyList = std::vector<flxProperty *>

Define a property list type - vector of properties.

◆ flxPropertySecretString

template<class Object >
using flxPropertySecretString = flxPropertyString<Object, true, true>

◆ flxPropertySecureString

template<class Object >
using flxPropertySecureString = flxPropertyString<Object, false, true>

Enumeration Type Documentation

◆ flxEditResult_t

Enumerator
flxEditSuccess 
flxEditFailure 
flxEditOutOfRange 

Function Documentation

◆ flxIsType()

template<class T >
bool flxIsType ( flxObject pObj)