A motor moving the head of the iCub at the given velocity. More...

Inheritance diagram for iCubHeadVelocityMotor:

Public Member Functions
	iCubHeadVelocityMotor (ConfigurationParameters &params, QString prefix)
	Constructor.

	~iCubHeadVelocityMotor ()
	Destructor.

virtual void	save (ConfigurationParameters &params, QString prefix)
	Saves current parameters into the given ConfigurationParameters object.

virtual int	size ()
	Returns the number of neurons required by this motor.

virtual void	update ()
	Performs the motor update. This also reads the activation of output neurons.

Public Member Functions inherited from iCubMotor
	iCubMotor (ConfigurationParameters &params, QString prefix)
	Constructor.

virtual	~iCubMotor ()
	Destructor.

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)
	Generates a description of this class and its parameters.

Static Public Member Functions inherited from iCubMotor
static void	describe (QString type)
	Describes all the parameters for this motor.

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)

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

Protected Member Functions inherited from Motor
QString	actualResourceNameForMultirobot (QString resourceName) const
	Returns the actual resource name to use.

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.

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

static void	setGraphicalEditor (QString type)

Protected Attributes inherited from iCubMotor
QString	icubResource
	The name of the resource associated with the icub robot.

QString	neuronsIteratorResource
	The name of th resource associated with the neural network iterator.

Detailed Description

A motor moving the head of the iCub at the given velocity.

The motor to move the head of the icub at the given velocity. This controls two degrees of freedom: pan (head joint 2) and tilt (head joint 0). We need two output neurons whose activation is in the range [0.0, 1.0]

In addition to all parameters defined by the parent class (Motor), this class also defines the following parameters:

icub: the name of the resource associated with the iCub robot to use

The resources required by this Motor are:

evonetIterator: the object to iterate over neurons of the neural network
robot: the simulated physical iCub robot

Definition at line 790 of file icubmotors.h.

Constructor & Destructor Documentation

iCubHeadVelocityMotor	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

Creates and configures the motor

Parameters

params	the ConfigurationParameters containing the parameters
prefix	the path prefix to the paramters for this Sensor

Definition at line 1287 of file icubmotors.cpp.

References iCubMotor::icubResource, iCubMotor::neuronsIteratorResource, and ConcurrentResourcesUser::usableResources().

~iCubHeadVelocityMotor ( )

Destructor.

Definition at line 1295 of file icubmotors.cpp.

Member Function Documentation

void describe ( QString type )

static

Generates a description of this class and its parameters.

Parameters

type	the string representation of this class name

Definition at line 1305 of file icubmotors.cpp.

References ParameterSettableInConstructor::addTypeDescription(), and iCubMotor::describe().

void save	(	ConfigurationParameters &	params,
		QString	prefix
	)

virtual

Saves current parameters into the given ConfigurationParameters object.

Parameters

params	the ConfigurationParameters object in which parameters should be saved
prefix	the name and path of the group where to save parametrs

Reimplemented from iCubMotor.

Definition at line 1299 of file icubmotors.cpp.

References iCubMotor::save(), and ConfigurationParameters::startObjectParameters().

int size ( )

virtual

Returns the number of neurons required by this motor.

Returns: the number of neurons required by this motor

Implements Motor.

Definition at line 1337 of file icubmotors.cpp.

void update ( )

virtual

Performs the motor update. This also reads the activation of output neurons.

Implements Motor.

Definition at line 1311 of file icubmotors.cpp.

References Motor::checkAllNeededResourcesExist(), NeuronsIterator::getOutput(), Motor::name(), iCubMotor::neuronsIteratorResource, NeuronsIterator::nextNeuron(), NeuronsIterator::setCurrentBlock(), and MultiMotorController::velocityMove().

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

experiments/include/icubmotors.h
experiments/src/icubmotors.cpp

Experiments - 1.2.3

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation