#include <flxCoreProps.h>

Inheritance diagram for _flxPropertyTyped< Object, T, HIDDEN, SECURE >:

Public Member Functions
	_flxPropertyTyped ()

	_flxPropertyTyped (T value)

	_flxPropertyTyped (T min, T max)

	_flxPropertyTyped (T value, T min, T max)

	_flxPropertyTyped (std::initializer_list< std::pair< const std::string, T > > limitSet)

	_flxPropertyTyped (T value, std::initializer_list< std::pair< const std::string, T > > limitSet)

void	operator() (Object *me)

void	operator() (Object obj, const char name)

void	operator() (Object obj, const char name, const char *desc)

T	get () const
	Get the value of the object as a templated type. A pure virtual method. More...

void	set (T const &value)

bool	operator> (int rhs)

bool	operator== (const T &rhs)

T	operator() () const

void	operator() (T const &value)

	operator T () const

_flxPropertyTyped< Object, T, HIDDEN, SECURE > &	operator= (T const &value)

Public Member Functions inherited from _flxPropertyBase< T, HIDDEN, SECURE >
	_flxPropertyBase ()

bool	hidden ()

void	setHidden (void)

bool	secure ()

flxDataType_t	type ()

virtual size_t	size ()

virtual size_t	save_size ()

virtual T	get (void) const =0
	Get the value of the object as a templated type. A pure virtual method. More...

virtual void	set (T const &value)=0

bool	save (flxStorageBlock *stBlk)

bool	restore (flxStorageBlock *stBlk)

virtual std::string	to_string (void)

flxEditResult_t	editValue (flxDataEditor &theEditor)

bool	setValue (flxDataVariable &value)

flxDataVariable	getValue (void)

flxDataLimit *	dataLimit (void)

virtual flxDataType_t	type (void)=0

virtual flxEditResult_t	editValue (flxDataEditor &)=0

virtual flxDataLimit *	dataLimit (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...

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)

flxDataLimit *	dataLimit (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)

Public Member Functions inherited from _flxDataOut< T >
flxDataType_t	type (void)
	Returns the data type of the object - based on the templated type. More...

virtual T	get (void) const =0
	Get the value of the object as a templated type. A pure virtual method. More...

bool	getBool ()
	Get the Bool value of the object. More...

int8_t	getInt8 ()
	Get the int8 value of the object. More...

int16_t	getInt16 ()
	Get the int16 value of the object. More...

int32_t	getInt32 ()
	Get the int32 value of the object. More...

uint8_t	getUInt8 ()
	Get the uint8 value of the object. More...

uint16_t	getUInt16 ()
	Get the uint16 value of the object. More...

uint32_t	getUInt32 ()
	Get the uint32 value of the object. More...

float	getFloat ()
	Get the float value of the object. More...

double	getDouble ()
	Get the double value of the object. More...

std::string	getString ()
	Get the string value 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
Public Types inherited from _flxDataOut< T >
typedef T	value_type
	A public member that is of the type of this object. Handy for templated code. More...

Protected Attributes inherited from flxDescriptor
const char *	_name

bool	_nameAlloc

const char *	_desc

bool	_descAlloc

const char *	_title

bool	_titleAlloc

Constructor & Destructor Documentation

◆ _flxPropertyTyped() [1/6]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE >::_flxPropertyTyped ( )

inline

◆ _flxPropertyTyped() [2/6]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE >::_flxPropertyTyped ( T value )

inline

◆ _flxPropertyTyped() [3/6]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE >::_flxPropertyTyped	(	T	min,
		T	max
	)

inline

◆ _flxPropertyTyped() [4/6]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE >::_flxPropertyTyped	(	T	value,
		T	min,
		T	max
	)

inline

◆ _flxPropertyTyped() [5/6]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE >::_flxPropertyTyped ( std::initializer_list< std::pair< const std::string, T > > limitSet )

inline

◆ _flxPropertyTyped() [6/6]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE >::_flxPropertyTyped	(	T	value,
		std::initializer_list< std::pair< const std::string, T > >	limitSet
	)

inline

Member Function Documentation

◆ get()

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

T _flxPropertyTyped< Object, T, HIDDEN, SECURE >::get ( ) const

inlinevirtual

Get the value of the object as a templated type. A pure virtual method.

Returns: T

Implements _flxPropertyBase< T, HIDDEN, SECURE >.

◆ operator T()

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator T ( ) const

inline

◆ operator()() [1/5]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

T _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator() ( ) const

inline

◆ operator()() [2/5]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

void _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator() ( Object * me )

inline

◆ operator()() [3/5]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

void _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator()	(	Object *	obj,
		const char *	name
	)

inline

◆ operator()() [4/5]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

void _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator()	(	Object *	obj,
		const char *	name,
		const char *	desc
	)

inline

◆ operator()() [5/5]

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

void _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator() ( T const & value )

inline

◆ operator=()

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

_flxPropertyTyped< Object, T, HIDDEN, SECURE > & _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator= ( T const & value )

inline

◆ operator==()

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

bool _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator== ( const T & rhs )

inline

◆ operator>()

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

bool _flxPropertyTyped< Object, T, HIDDEN, SECURE >::operator> ( int rhs )

inline

◆ set()

template<class Object , class T , bool HIDDEN = false, bool SECURE = false>

void _flxPropertyTyped< Object, T, HIDDEN, SECURE >::set ( T const & value )

inlinevirtual

Implements _flxPropertyBase< T, HIDDEN, SECURE >.

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

src/core/flux_base/flxCoreProps.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ _flxPropertyTyped() [1/6]

◆ _flxPropertyTyped() [2/6]

◆ _flxPropertyTyped() [3/6]

◆ _flxPropertyTyped() [4/6]

◆ _flxPropertyTyped() [5/6]

◆ _flxPropertyTyped() [6/6]

Member Function Documentation

◆ get()

◆ operator T()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ operator=()

◆ operator==()

◆ operator>()

◆ set()