flxApplication Class Reference

#include <flxFlux.h>

Inheritance diagram for flxApplication:

Public Member Functions
	flxApplication ()
void	setName (const char *name)
void	setDescription (const char *desc)
void	setName (const char *name, const char *desc)
const char *	name (void)
const char *	description (void)
virtual void	onInit (void)
virtual bool	onSetup (void)
virtual bool	onStart (void)
virtual void	onDeviceLoad (void)
virtual void	onRestore (void)
void	setVersion (uint major, uint minor, uint point, const char *desc, uint32_t build)
void	setAppClassID (const char *ID, char prefix[5])
virtual bool	loop (void)
Public Member Functions inherited from flxActionType< flxApplication >
flxTypeID	getType (void)
Public Member Functions inherited from flxAction
virtual bool	initialize (void)
Public Member Functions inherited from flxOperation
virtual flxTypeID	getType (void)
virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...
virtual bool	onSave (flxStorageBlock *stBlk)
virtual bool	onRestore (flxStorageBlock *stBlk)
Public Member Functions inherited from flxObject
	flxObject ()
virtual	~flxObject ()
void	setParent (flxObject *parent)
void	setParent (flxObject &parent)
flxObject *	parent ()
void	setHidden (bool bHide=true)
bool	hidden ()
void	setIsDirty (bool bDirty=true)
bool	isDirty (void)
virtual bool	onSave (flxStorageBlock *stBlk)
virtual bool	save (flxStorage *pStorage)
virtual bool	onRestore (flxStorageBlock *stBlk)
virtual bool	restore (flxStorage *pStorage)
virtual flxTypeID	getType (void)
virtual bool	save (flxStorage *)=0
virtual bool	restore (flxStorage *)=0
Public Member Functions inherited from _flxPropertyContainer
	_flxPropertyContainer ()
void	addProperty (flxProperty *newProperty)
void	addProperty (flxProperty &newProperty)
void	removeProperty (flxProperty *rmProp)
void	removeProperty (flxProperty &rmProp)
flxPropertyList &	getProperties (void)
uint	nProperties (void)
bool	saveProperties (flxStorageBlock *stBlk)
bool	restoreProperties (flxStorageBlock *stBlk)
size_t	propertySaveSize ()
void	hideProperty (flxProperty &theProp)
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 _flxParameterContainer
void	addParameter (flxParameterIn *newParam, bool head=false)
void	addParameter (flxParameterIn &newParam, bool head=false)
void	removeParameter (flxParameterIn *rmParam)
void	removeParameter (flxParameterIn &rmParam)
size_t	nInputParameters ()
void	addParameter (flxParameterOut *newParam, bool head=false)
void	addParameter (flxParameterOut &newParam, bool head=false)
void	removeParameter (flxParameterOut *rmParam)
void	removeParameter (flxParameterOut &rmParam)
size_t	nOutputParameters ()
flxParameterOutList &	getOutputParameters (void)
flxParameterInList &	getInputParameters (void)

Public Attributes
flxDescriptor	appDesc

Additional Inherited Members
Static Public Member Functions inherited from flxActionType< flxApplication >
static flxTypeID	type (void)
Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Constructor & Destructor Documentation

flxApplication()

flxApplication::flxApplication ( )

inline

Member Function Documentation

description()

const char * flxApplication::description ( void  )

inline

loop()

virtual bool flxApplication::loop ( void  )

inlinevirtual

name()

const char * flxApplication::name ( void  )

inline

onDeviceLoad()

virtual void flxApplication::onDeviceLoad ( void  )

inlinevirtual

onInit()

virtual void flxApplication::onInit ( void  )

inlinevirtual

onRestore()

virtual void flxApplication::onRestore ( void  )

inlinevirtual

onSetup()

virtual bool flxApplication::onSetup ( void  )

inlinevirtual

onStart()

virtual bool flxApplication::onStart ( void  )

inlinevirtual

setAppClassID()

void flxApplication::setAppClassID ( const char *  ID, char  prefix[5]  )

inline

setDescription()

void flxApplication::setDescription ( const char *  desc )

inline

setName() [1/2]

void flxApplication::setName ( const char *  name )

inline

setName() [2/2]

void flxApplication::setName ( const char *  name, const char *  desc  )

inline

setVersion()

void flxApplication::setVersion ( uint  major, uint  minor, uint  point, const char *  desc, uint32_t  build  )

inline

Member Data Documentation

appDesc

flxDescriptor flxApplication::appDesc

---

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

• src/core/flux_base/flxFlux.h