Updatable Class Reference

Updatables objects. More...

Inheritance diagram for Updatable:

Public Member Functions
	Updatable (QString name="unnamed")
	Constructor. More...
	Updatable (ConfigurationParameters &params, QString prefix)
	Constructor. More...
virtual	~Updatable ()
	Destructor. More...
QString	name () const
	Return its name. More...
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed. More...
void	setName (QString newname)
	Set the name of Updatable. More...
virtual void	update ()=0
	Update the object. More...
Public Member Functions inherited from ParameterSettableInConstructor
	ParameterSettableInConstructor (ConfigurationParameters &, QString)
Public Member Functions inherited from ParameterSettable
void	addObserver (RuntimeParameterObserver *obs)
T	getRuntimeParameter (QString paramName)
virtual ParameterSettableUI *	getUIManager ()
virtual void	postConfigureInitialization ()
void	removeObserver (RuntimeParameterObserver *obs)
void	setRuntimeParameter (QString paramName, T newvalue)
QString	typeName () const

Static Public Member Functions
static void	describe (QString type)
	Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups. More...
Static Public Member Functions inherited from ParameterSettable
static void	describe (QString type)
static QString	fullParameterDescriptionPath (QString type, QString param)
static QString	fullSubgroupDescriptionPath (QString type, QString sub)

Additional Inherited Members
Public Types inherited from ParameterSettable
enum	Property
Public Attributes inherited from ParameterSettable
	AllowMultiple
	Default
	IsList
	IsMandatory
Static Public Attributes inherited from ParameterSettable
static const double	Infinity
static const int	MaxInteger
static const int	MinInteger
Protected Member Functions inherited from ParameterSettable
void	notifyChangesToParam (QString paramName)
Static Protected Member Functions inherited from ParameterSettable
static Descriptor	addTypeDescription (QString type, QString shortHelp, QString longHelp=QString(""))
static void	setGraphicalEditor (QString type)

Detailed Description

Updatables objects.

The Updatable objects has a name.

Definition at line 37 of file updatable.h.

Constructor & Destructor Documentation

Updatable

(

QString

name = "unnamed"

)

Constructor.

Definition at line 24 of file updatable.cpp.

References Updatable::setName().

Updatable	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

Definition at line 30 of file updatable.cpp.

References ConfigurationParameters::GroupSeparator(), and Updatable::setName().

~Updatable ( )

virtual

Destructor.

Definition at line 45 of file updatable.cpp.

Member Function Documentation

void describe ( QString  type )

static

Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups.

Definition at line 61 of file updatable.cpp.

References ParameterSettable::addTypeDescription().

Referenced by Linker::describe(), and Cluster::describe().

QString name

(

)

const

Return its name.

Definition at line 52 of file updatable.cpp.

Referenced by NeuralNet::addCluster(), NeuralNet::addLinker(), NeuralNet::removeCluster(), NeuralNet::removeLinker(), BackPropagationAlgo::save(), and NeuralNet::save().

void save ( ConfigurationParameters &  params, QString  prefix  )

virtual

Save the actual status of parameters into the ConfigurationParameters object passed.

This saves the name property, remember to call this in child classes

Parameters

params	the configuration parameters object on which save actual parameters
prefix	the prefix to use to access the object configuration parameters.

Implements ParameterSettable.

Reimplemented in Cluster, Linker, MatrixLinker, BiasedCluster, CopyLinker, DotLinker, SimpleCluster, and NormLinker.

Definition at line 56 of file updatable.cpp.

References ConfigurationParameters::startObjectParameters().

Referenced by Linker::save(), and Cluster::save().

void setName

(

QString

newname

)

Set the name of Updatable.

Definition at line 48 of file updatable.cpp.

Referenced by Updatable::Updatable().

virtual void update ( )

pure virtual

Update the object.

Implemented in CopyLinker, BiasedCluster, DotLinker, NormLinker, and SimpleCluster.

---

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

• nnfw/include/updatable.h
• nnfw/src/updatable.cpp