FakeMotor adds a number of additional outputs that actually do not control any real motors but are useful to control or to modulate other neurons. More...

Inheritance diagram for FakeMotor:

[legend]

Public Member Functions
	FakeMotor (ConfigurationParameters &params, QString prefix)
	Constructor and Configure.

	~FakeMotor ()
	Destructor.

void	save (ConfigurationParameters &params, QString prefix)
	Save the parameters of the FakeMotor into the ConfigurationParameters.

int	size ()
	Return the number of neurons This correspond to the paramenter nMotors present into the ConfigurationParameters used for configuring the FakeMotor.

void	update ()
	Update the state of the Motor every time step.

Public Member Functions inherited from Motor
	Motor (ConfigurationParameters &params, QString prefix)
	Constructor and Configure.

	~Motor ()
	Destructor.

QString	name ()
	Return the name of the Sensor.

void	save (ConfigurationParameters &params, QString prefix)
	Save the parameters into the ConfigurationParameters.

void	setName (QString name)
	Use this method for changing the name of the Sensor.

Public Member Functions inherited from ParameterSettableInConstructor
	ParameterSettableInConstructor (ConfigurationParameters &, QString)

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

Public Member Functions inherited from ConcurrentResourcesUser
void	addUsableResource (QString resource)

void	addUsableResources (QStringList resources)

void	declareResource (QString name, T *resource, QString lockBuddy="")

void	deleteResource (QString name)

T *	getResource (QString name, bool *resourceExists=NULL)

bool	hasResource (QString name) const

void	removeAllUsableResources ()

void	removeUsableResource (QString resource)

void	removeUsableResources (QStringList resources)

virtual void	shareResourcesWith (ResourcesUser *buddy)

void	usableResources (QStringList resources)

bool	usedResourcesExist (QStringList *nonExistingResources=NULL) const

Static Public Member Functions
static void	describe (QString type)
	Describe all the parameter for configuring the FakeMotor.

Static Public Member Functions inherited from Motor
static void	describe (QString type)
	Describe all the parameter for configuring the Motor.

Static Public Member Functions inherited from ParameterSettableInConstructor
static void	describe (QString type)

static QString	fullParameterDescriptionPath (QString type, QString param)

static QString	fullSubgroupDescriptionPath (QString type, QString sub)

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)

Protected Member Functions
void	resourceChanged (QString resourceName, ResourceChangeType changeType)
	The function called when a resource used here is changed.

Protected Member Functions inherited from Motor
void	checkAllNeededResourcesExist ()
	Checks whether all resources we need are existing and throws an exception if they aren't.

void	resetNeededResourcesCheck ()
	Resets the check on needed resources so that the next call to checkAllNeededResourcesExist() will perform the full check and not the quick one.

Protected Member Functions inherited from ParameterSettableInConstructor
void	notifyChangesToParam (QString paramName)

Protected Member Functions inherited from ParameterSettable
void	notifyChangesToParam (QString paramName)

Protected Member Functions inherited from ConcurrentResourcesUser
T *	getResource ()

ResourcesUser &	operator= (const ResourcesUser &other)

	ResourcesUser ()

	ResourcesUser (const ResourcesUser &other)

Protected Member Functions inherited from ResourcesUser
	ResourcesUser (const ResourcesUser &other)

virtual void	notifyResourceChange (ResourceHandler *resource, ResourceChangeType changeType)=0

ResourcesUser &	operator= (const ResourcesUser &other)

Protected Attributes
int	nFakeMotors
	the number of neurons associated to FakeMotor

Additional Inherited Members
Public Types inherited from ParameterSettableInConstructor
enum	Property

Public Types inherited from ConcurrentResourcesUser
typedef Resource::ResourceChangeType	ResourceChangeType

Public Attributes inherited from ParameterSettableInConstructor
	AllowMultiple

	Default

	IsList

	IsMandatory

Static Public Attributes inherited from ParameterSettableInConstructor
static const double	Infinity

static const int	MaxInteger

static const int	MinInteger

Static Protected Member Functions inherited from ParameterSettableInConstructor
static Descriptor	addTypeDescription (QString type, QString shortHelp, QString longHelp=QString(""))

Detailed Description

FakeMotor adds a number of additional outputs that actually do not control any real motors but are useful to control or to modulate other neurons.

Definition at line 38 of file motors.h.

Constructor & Destructor Documentation

FakeMotor	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor and Configure.

Parameters

params	is the ConfigurationParameters containing the parameters
prefix	is the path prefix to the paramters for this Motor

Definition at line 34 of file motors.cpp.

References ConfigurationHelper::getInt(), FakeMotor::nFakeMotors, and ConcurrentResourcesUser::usableResources().

~FakeMotor ( )

Destructor.

Definition at line 43 of file motors.cpp.

Member Function Documentation

void describe ( QString type )

static

Describe all the parameter for configuring the FakeMotor.

Definition at line 53 of file motors.cpp.

References ParameterSettableInConstructor::addTypeDescription(), ParameterSettable::IntDescriptor::def(), Motor::describe(), ParameterSettable::Descriptor::describeInt(), ParameterSettable::IntDescriptor::help(), ParameterSettableInConstructor::IsMandatory, ParameterSettable::IntDescriptor::limits(), and ParameterSettable::IntDescriptor::props().

void resourceChanged	(	QString	resourceName,
		ResourceChangeType	changeType
	)

protectedvirtual

The function called when a resource used here is changed.

Parameters

resourceName	the name of the resource that has changed.
chageType	the type of change the resource has gone through (whether it was created, modified or deleted)

Reimplemented from ConcurrentResourcesUser.

Definition at line 68 of file motors.cpp.

References Logger::info(), Motor::name(), NeuronsIterator::nextNeuron(), FakeMotor::nFakeMotors, Motor::resetNeededResourcesCheck(), NeuronsIterator::setCurrentBlock(), and NeuronsIterator::setGraphicProperties().