FakeMotor Class Reference
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...

Public Member Functions | |
FakeMotor (ConfigurationParameters ¶ms, QString prefix) | |
Constructor and Configure. | |
~FakeMotor () | |
Destructor. | |
void | save (ConfigurationParameters ¶ms, 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. | |
Static Public Member Functions | |
static void | describe (QString type) |
Describe all the parameter for configuring the FakeMotor. | |
Protected Member Functions | |
void | resourceChanged (QString resourceName, ResourceChangeType changeType) |
The function called when a resource used here is changed. | |
Protected Attributes | |
int | nFakeMotors |
the number of neurons associated to FakeMotor |
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.
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.
Reimplemented from Motor.
Definition at line 53 of file motors.cpp.
References ParameterSettable::addTypeDescription(), ParameterSettable::IntDescriptor::def(), ParameterSettable::Descriptor::describeInt(), ParameterSettable::IntDescriptor::help(), ParameterSettable::IsMandatory, ParameterSettable::IntDescriptor::limits(), and ParameterSettable::IntDescriptor::props().
void resourceChanged | ( | QString | resourceName, |
ResourceChangeType | changeType | ||
) | [protected, virtual] |
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().
void save | ( | ConfigurationParameters & | params, |
QString | prefix | ||
) | [virtual] |
Save the parameters of the FakeMotor into the ConfigurationParameters.
- Parameters:
-
params is the ConfigurationParameters where save the parameters prefix is the path prefix for the parameters to save
Reimplemented from Motor.
Definition at line 47 of file motors.cpp.
References ConfigurationParameters::createParameter(), FakeMotor::nFakeMotors, and ConfigurationParameters::startObjectParameters().
int size | ( | ) | [virtual] |
Return the number of neurons This correspond to the paramenter nMotors present into the ConfigurationParameters used for configuring the FakeMotor.
Implements Motor.
Definition at line 64 of file motors.cpp.
References FakeMotor::nFakeMotors.
void update | ( | ) | [virtual] |
Update the state of the Motor every time step.
Implements Motor.
Definition at line 59 of file motors.cpp.
References Motor::checkAllNeededResourcesExist().
Member Data Documentation
int nFakeMotors [protected] |
the number of neurons associated to FakeMotor
Definition at line 69 of file motors.h.
Referenced by FakeMotor::FakeMotor(), FakeMotor::resourceChanged(), FakeMotor::save(), and FakeMotor::size().
The documentation for this class was generated from the following files:
- experiments/include/motors.h
- experiments/src/motors.cpp