flxParameterInVoid< Object, _setter > Class Template Reference

#include <flxCoreParam.h>

Inheritance diagram for flxParameterInVoid< Object, _setter >:

Public Member Functions
	flxParameterInVoid ()
	flxParameterInVoid (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	set ()
void	operator() ()
flxEditResult_t	editValue (flxDataEditor &theEditor)
flxDataLimit *	dataLimit (void)
bool	setValue (flxDataVariable &value)
Public Member Functions inherited from flxParameterInVoidType
	flxParameterInVoidType ()
virtual void	set (void)=0
Public Member Functions inherited from flxParameterIn
virtual flxEditResult_t	editValue (flxDataEditor &)=0
virtual bool	setValue (flxDataVariable &)=0
virtual flxDataLimit *	dataLimit (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...

Additional Inherited Members
Public Attributes inherited from flxParameterInVoidType
bool	prompt
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Constructor & Destructor Documentation

flxParameterInVoid() [1/2]

template<class Object , void(Object::*)() _setter>

flxParameterInVoid< Object, _setter >::flxParameterInVoid ( )

inline

flxParameterInVoid() [2/2]

template<class Object , void(Object::*)() _setter>

flxParameterInVoid< Object, _setter >::flxParameterInVoid ( Object *  me )

inline

Member Function Documentation

dataLimit()

template<class Object , void(Object::*)() _setter>

flxDataLimit * flxParameterInVoid< Object, _setter >::dataLimit ( void  )

inlinevirtual

Implements flxParameterIn.

editValue()

template<class Object , void(Object::*)() _setter>

flxEditResult_t flxParameterInVoid< Object, _setter >::editValue ( flxDataEditor &  theEditor )

inlinevirtual

Implements flxParameterIn.

operator()() [1/5]

template<class Object , void(Object::*)() _setter>

void flxParameterInVoid< Object, _setter >::operator() ( )

inline

operator()() [2/5]

template<class Object , void(Object::*)() _setter>

void flxParameterInVoid< Object, _setter >::operator() ( Object *  obj )

inline

operator()() [3/5]

template<class Object , void(Object::*)() _setter>

void flxParameterInVoid< Object, _setter >::operator() ( Object *  obj, const char *  name  )

inline

operator()() [4/5]

template<class Object , void(Object::*)() _setter>

void flxParameterInVoid< Object, _setter >::operator() ( Object *  obj, const char *  name, const char *  desc  )

inline

operator()() [5/5]

template<class Object , void(Object::*)() _setter>

void flxParameterInVoid< Object, _setter >::operator() ( Object *  obj, const char *  name, const char *  desc, flxParamValueType_t  vtype  )

inline

set()

template<class Object , void(Object::*)() _setter>

void flxParameterInVoid< Object, _setter >::set ( void  )

inlinevirtual

Implements flxParameterInVoidType.

setValue()

template<class Object , void(Object::*)() _setter>

bool flxParameterInVoid< Object, _setter >::setValue ( flxDataVariable &  value )

inlinevirtual

Implements flxParameterIn.

type()

template<class Object , void(Object::*)() _setter>

flxDataType_t flxParameterInVoid< Object, _setter >::type ( void  )

inlinevirtual

Implements flxParameter.

---

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

• src/core/flux_base/flxCoreParam.h