Updatable Class Reference

Updatables objects. More...

Inheritance diagram for Updatable:

List of all members.

Public Member Functions
	Updatable (QString name="unnamed")
	Constructor.
	Updatable (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~Updatable ()
	Destructor.
QString	name () const
	Return its name.
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed.
void	setName (QString newname)
	Set the name of Updatable.
virtual void	update ()=0
	Update the object.
Static Public Member Functions
static void	describe (QString type)
	Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups.

---

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.

Reimplemented from ParameterSettable.

Reimplemented in BiasedCluster, Cluster, DDECluster, FakeCluster, Linker, and SimpleCluster.

Definition at line 61 of file updatable.cpp.

References ParameterSettable::addTypeDescription().

QString name

(

)

const

Return its name.

Definition at line 52 of file updatable.cpp.

Referenced by NeuralNet::addCluster(), NeuralNet::addLinker(), NeuralNet::removeCluster(), NeuralNet::removeLinker(), NeuralNet::save(), and BackPropagationAlgo::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 BiasedCluster, Cluster, CopyLinker, DDECluster, DotLinker, FakeCluster, Linker, MatrixLinker, NormLinker, and SimpleCluster.

Definition at line 56 of file updatable.cpp.

References ConfigurationParameters::startObjectParameters().

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 BiasedCluster, CopyLinker, DDECluster, DotLinker, FakeCluster, NormLinker, and SimpleCluster.

---

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

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