Component Class Reference

The Component is the base (abstract) class for any specific project implementation. More...

Inheritance diagram for Component:

Signals
void	statusChanged (QString newStatus)
	emitted when the status is changed

Public Member Functions
	Component ()
	Constructor.
virtual	~Component ()
	Destructor.
virtual void	configure (ConfigurationParameters &params, QString prefix)=0
	Configure function.
virtual void	save (ConfigurationParameters &params, QString prefix)=0
	Save function.
void	setStatus (QString newStatus)
	used by subclasses to change the status of the experiment
QString	status ()
	return a text description of the current status of the component
Public Member Functions inherited from ParameterSettableWithConfigureFunction
void	addObserver (RuntimeParameterObserver *obs)
T	getRuntimeParameter (QString paramName)
virtual ParameterSettableUI *	getUIManager ()
	ParameterSettable ()
virtual void	postConfigureInitialization ()
void	removeObserver (RuntimeParameterObserver *obs)
void	setRuntimeParameter (QString paramName, T newvalue)
QString	typeName () const
Public Member Functions inherited from ParameterSettable
void	addObserver (RuntimeParameterObserver *obs)
T	getRuntimeParameter (QString paramName)
void	removeObserver (RuntimeParameterObserver *obs)
void	setRuntimeParameter (QString paramName, T newvalue)
QString	typeName () const

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

Detailed Description

The Component is the base (abstract) class for any specific project implementation.

The Component is the object loaded by Total99 interface for setting up the project and the experiment

The subclasses of Component will represent the schema or the template for a specific kind of experiment. For example, GAComponent implement the basic logic for an evolutionary experiment, while the iCubSimulator implement not really an experiment but the simulation of an iCub robot on which you can play with YARP

Definition at line 45 of file component.h.

Constructor & Destructor Documentation

Component ( )

inline

Constructor.

Definition at line 49 of file component.h.

virtual ~Component ( )

inlinevirtual

Destructor.

Definition at line 51 of file component.h.

Member Function Documentation

virtual void configure ( ConfigurationParameters &  params, QString  prefix  )

pure virtual

Configure function.

Implements ParameterSettableWithConfigureFunction.

Implemented in iCubSimulator, and EvoRobotComponent.

virtual void save ( ConfigurationParameters &  params, QString  prefix  )

pure virtual

Save function.

Implements ParameterSettableWithConfigureFunction.

Implemented in iCubSimulator, and EvoRobotComponent.

void setStatus ( QString  newStatus )

inline

used by subclasses to change the status of the experiment

Definition at line 61 of file component.h.

Referenced by EvoRobotComponent::configure(), iCubSimulator::configure(), EvoRobotComponent::onThreadOperationDone(), EvolveOperation::run(), TestOperation::run(), iCubSimulator::start(), iCubSimulator::step(), and iCubSimulator::suspend().

QString status ( )

inline

return a text description of the current status of the component

Definition at line 53 of file component.h.

void statusChanged ( QString  newStatus )

signal

emitted when the status is changed

---

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

• experiments/include/component.h