#include <flxCoreParam.h>

Inheritance diagram for _flxParameterOut< T, Object, _getter >:

Public Member Functions
	_flxParameterOut ()

	_flxParameterOut (Object *me)

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	setEnabled (bool bEnabled)

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

T	operator() () const

bool	getBool ()
	Get the data as a boolean. More...

int8_t	getInt8 ()
	Get the data as an int8_t. More...

int16_t	getInt16 ()
	Get the data as an int16_t. More...

int32_t	getInt32 ()
	Get the data as an int32_t. More...

uint8_t	getUInt8 ()
	Get the data as a uint8_t. More...

uint16_t	getUInt16 ()
	Get the data as a uint16_t. More...

uint32_t	getUInt32 ()
	Get the data as a uint32_t. More...

float	getFloat ()
	Get the data as a float. More...

double	getDouble ()
	Get the data as a double. More...

std::string	getString ()
	Get the data as a string. More...

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...

Public Member Functions inherited from flxParameterOutScalar
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...

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 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

Constructor & Destructor Documentation

◆ _flxParameterOut() [1/2]

template<class T , class Object , T(Object::*)() _getter>

_flxParameterOut< T, Object, _getter >::_flxParameterOut ( )

inline

◆ _flxParameterOut() [2/2]

template<class T , class Object , T(Object::*)() _getter>

_flxParameterOut< T, Object, _getter >::_flxParameterOut ( Object * me )

inline

Member Function Documentation

◆ get()

template<class T , class Object , T(Object::*)() _getter>

T _flxParameterOut< T, Object, _getter >::get ( ) const

inlinevirtual

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

Returns: T

Implements _flxDataOut< T >.

◆ getBool()

template<class T , class Object , T(Object::*)() _getter>

bool _flxParameterOut< T, Object, _getter >::getBool ( )

inlinevirtual

Get the data as a boolean.

Returns: bool

Implements flxDataOut.

◆ getDouble()

template<class T , class Object , T(Object::*)() _getter>

double _flxParameterOut< T, Object, _getter >::getDouble ( )

inlinevirtual

Get the data as a double.

Returns: double

Implements flxDataOut.

◆ getFloat()

template<class T , class Object , T(Object::*)() _getter>

float _flxParameterOut< T, Object, _getter >::getFloat ( )

inlinevirtual

Get the data as a float.

Returns: float

Implements flxDataOut.

◆ getInt16()

template<class T , class Object , T(Object::*)() _getter>

int16_t _flxParameterOut< T, Object, _getter >::getInt16 ( )

inlinevirtual

Get the data as an int16_t.

Returns: int16_t

Implements flxDataOut.

◆ getInt32()

template<class T , class Object , T(Object::*)() _getter>

int32_t _flxParameterOut< T, Object, _getter >::getInt32 ( )

inlinevirtual

Get the data as an int32_t.

Returns: int32_t

Implements flxDataOut.

◆ getInt8()

template<class T , class Object , T(Object::*)() _getter>

int8_t _flxParameterOut< T, Object, _getter >::getInt8 ( )

inlinevirtual

Get the data as an int8_t.

Returns: int8_t

Implements flxDataOut.

◆ getString()

template<class T , class Object , T(Object::*)() _getter>

std::string _flxParameterOut< T, Object, _getter >::getString ( )

inlinevirtual

Get the data as a string.

Returns: std::string

Implements flxDataOut.

◆ getUInt16()

template<class T , class Object , T(Object::*)() _getter>

uint16_t _flxParameterOut< T, Object, _getter >::getUInt16 ( )

inlinevirtual

Get the data as a uint16_t.

Returns: uint16_t

Implements flxDataOut.

◆ getUInt32()

template<class T , class Object , T(Object::*)() _getter>

uint32_t _flxParameterOut< T, Object, _getter >::getUInt32 ( )

inlinevirtual

Get the data as a uint32_t.

Returns: uint32_t

Implements flxDataOut.

◆ getUInt8()

template<class T , class Object , T(Object::*)() _getter>

uint8_t _flxParameterOut< T, Object, _getter >::getUInt8 ( )

inlinevirtual

Get the data as a uint8_t.

Returns: uint8_t

Implements flxDataOut.

◆ operator()() [1/5]

template<class T , class Object , T(Object::*)() _getter>

T _flxParameterOut< T, Object, _getter >::operator() ( ) const

inline

◆ operator()() [2/5]

template<class T , class Object , T(Object::*)() _getter>

void _flxParameterOut< T, Object, _getter >::operator() ( Object * obj )

inline

◆ operator()() [3/5]

template<class T , class Object , T(Object::*)() _getter>

void _flxParameterOut< T, Object, _getter >::operator()	(	Object *	obj,
		const char *	name
	)

inline

◆ operator()() [4/5]

template<class T , class Object , T(Object::*)() _getter>

void _flxParameterOut< T, Object, _getter >::operator()	(	Object *	obj,
		const char *	name,
		const char *	desc
	)

inline

◆ operator()() [5/5]

template<class T , class Object , T(Object::*)() _getter>

void _flxParameterOut< T, Object, _getter >::operator()	(	Object *	obj,
		const char *	name,
		const char *	desc,
		flxParamValueType_t	vtype
	)

inline

◆ setEnabled()

template<class T , class Object , T(Object::*)() _getter>

void _flxParameterOut< T, Object, _getter >::setEnabled ( bool bEnabled )

inlinevirtual

Reimplemented from flxParameter.

◆ type()

template<class T , class Object , T(Object::*)() _getter>

flxDataType_t _flxParameterOut< T, Object, _getter >::type ( void )

inlinevirtual

Implements flxParameterOutScalar.

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

src/core/flux_base/flxCoreParam.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ _flxParameterOut() [1/2]

◆ _flxParameterOut() [2/2]

Member Function Documentation

◆ get()

◆ getBool()

◆ getDouble()

◆ getFloat()

◆ getInt16()

◆ getInt32()

◆ getInt8()

◆ getString()

◆ getUInt16()

◆ getUInt32()

◆ getUInt8()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ setEnabled()

◆ type()