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

A string read/write property object that takes a getter and a setter method and the target object. More...

#include <flxCoreProps.h>

Inheritance diagram for flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >:
_flxPropertyBaseString< HIDDEN, SECURE > flxProperty _flxDataInString _flxDataOutString flxDescriptor

Public Member Functions

 flxPropertyRWString ()
 
 flxPropertyRWString (std::string value)
 
void operator() (Object *obj, bool skipAdd=false)
 
void operator() (Object *obj, const char *name)
 
void operator() (Object *obj, const char *name, const char *desc)
 
bool operator== (const std::string &rhs)
 
bool operator!= (const std::string &rhs)
 
bool operator== (const char *rhs)
 
bool operator!= (const char *rhs)
 
std::string get () const
 
void set (std::string const &value)
 
std::string operator() () const
 
void operator() (std::string const &value)
 
 operator std::string () const
 
flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE > & operator= (std::string const &value)
 
- Public Member Functions inherited from _flxPropertyBaseString< HIDDEN, SECURE >
 _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)
 
flxDataLimitdataLimit (void)
 
bool setValue (flxDataVariable &value)
 
flxDataVariable getValue (void)
 
virtual flxDataType_t type (void)=0
 
virtual flxEditResult_t editValue (flxDataEditor &)=0
 
virtual flxDataLimitdataLimit (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...
 

Additional Inherited Members

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

Detailed Description

template<class Object, std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
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.

Template Parameters
ObjectThe containing object of this property
(Object::*_getter)()The method of Object to call when the property is read
(Object::*_setter)(bool)The method of Object to call when the property is set

Constructor & Destructor Documentation

◆ flxPropertyRWString() [1/2]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::flxPropertyRWString ( )
inline

◆ flxPropertyRWString() [2/2]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::flxPropertyRWString ( std::string  value)
inline

Member Function Documentation

◆ get()

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
std::string flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::get ( void  ) const
inlinevirtual

◆ operator std::string()

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator std::string ( ) const
inline

◆ operator!=() [1/2]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
bool flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator!= ( const char *  rhs)
inline

◆ operator!=() [2/2]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
bool flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator!= ( const std::string &  rhs)
inline

◆ operator()() [1/5]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
std::string flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator() ( ) const
inline

◆ operator()() [2/5]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
void flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator() ( Object *  obj,
bool  skipAdd = false 
)
inline

◆ operator()() [3/5]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
void flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator() ( Object *  obj,
const char *  name 
)
inline

◆ operator()() [4/5]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
void flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator() ( Object *  obj,
const char *  name,
const char *  desc 
)
inline

◆ operator()() [5/5]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
void flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator() ( std::string const &  value)
inline

◆ operator=()

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE > & flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator= ( std::string const &  value)
inline

◆ operator==() [1/2]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
bool flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator== ( const char *  rhs)
inline

◆ operator==() [2/2]

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
bool flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::operator== ( const std::string &  rhs)
inline

◆ set()

template<class Object , std::string(Object::*)() _getter, void(Object::*)(std::string) _setter, bool HIDDEN = false, bool SECURE = false>
void flxPropertyRWString< Object, _getter, _setter, HIDDEN, SECURE >::set ( std::string const &  value)
inlinevirtual

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