iCubSensor Class Reference

The base abstract class for iCub sensors. More...

Inheritance diagram for iCubSensor:

List of all members.

Public Member Functions
	iCubSensor (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~iCubSensor ()
	Destructor.
virtual void	save (ConfigurationParameters &params, QString prefix)
	Saves the parameters of the sensor into the ConfigurationParameters object.
Static Public Member Functions
static void	describe (QString type)
	Describes all the parameters for this sensor.
Protected Member Functions
virtual void	resourceChanged (QString resourceName, ResourceChangeType changeType)
	The function called when a resource used here is changed.
Protected Attributes
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

The base abstract class for iCub sensors.

This class simply has a couple of parameters that are common to all iCub sensors (see below).

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

• icub: the name of the resource associated with the iCub robot to use (default is "robot")
• neuronsIterator: the name of the resource associated with the neural network iterator (default is "neuronsIterator")

The resources required by this Sensor are:

• name defined by the icub parameter: the simulated physical iCub robot
• name defined by the neuronsIterator parameter: the object to iterate over neurons of the neural network

Definition at line 60 of file icubsensors.h.

---

Constructor & Destructor Documentation

iCubSensor	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

This also reads configuration parameters. Moreover this adds the icub and neuronsIterator resources to the list of resources used here

Parameters:

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

Definition at line 35 of file icubsensors.cpp.

References ConfigurationHelper::getString(), iCubSensor::icubResource, iCubSensor::neuronsIteratorResource, and ConcurrentResourcesUser::usableResources().

~iCubSensor

(

)

[virtual]

Destructor.

Definition at line 48 of file icubsensors.cpp.

---

Member Function Documentation

void describe

(

QString

type

)

[static]

Describes all the parameters for this sensor.

Parameters:

type	the name with which this sensor is registered into the factory

Reimplemented from Sensor.

Reimplemented in iCubArmJointsSensor, ColorCameraSensor, iCubPalmTargetDistSensor, iCubPalmTouchSensor, iCubHandTouchSensor, iCubTorsoJointsSensor, iCubHeadJointsSensor, iCubHandJointsSensor, iCubFingertipsTouchSensor, iCubPalmPatchesTouchSensor, and HandObjectVisualOffsetSensor.

Definition at line 64 of file icubsensors.cpp.

References ParameterSettable::addTypeDescription(), ParameterSettable::StringDescriptor::def(), ParameterSettable::Descriptor::describeString(), and ParameterSettable::StringDescriptor::help().

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.

Reimplemented in iCubArmJointsSensor, iCubPalmTargetDistSensor, iCubPalmTouchSensor, iCubTorsoJointsSensor, iCubHeadJointsSensor, and iCubHandJointsSensor.

Definition at line 75 of file icubsensors.cpp.

References Sensor::resetNeededResourcesCheck().

void save	(	ConfigurationParameters &	params,
		QString	prefix
	)		[virtual]

Saves the parameters of the sensor into the ConfigurationParameters object.

Parameters:

params	the ConfigurationParameters where save the parameters of the sensors
prefix	the path prefix for the parameters to save

Reimplemented from Sensor.

Reimplemented in iCubArmJointsSensor, ColorCameraSensor, iCubPalmTargetDistSensor, iCubPalmTouchSensor, iCubHandTouchSensor, iCubTorsoJointsSensor, iCubHeadJointsSensor, iCubHandJointsSensor, iCubFingertipsTouchSensor, iCubPalmPatchesTouchSensor, and HandObjectVisualOffsetSensor.

Definition at line 53 of file icubsensors.cpp.

References ConfigurationParameters::createParameter(), iCubSensor::icubResource, iCubSensor::neuronsIteratorResource, and ConfigurationParameters::startObjectParameters().

---

Member Data Documentation

QString icubResource [protected]

The name of the resource associated with the iCub robot.

Definition at line 111 of file icubsensors.h.

Referenced by ColorCameraSensor::ColorCameraSensor(), HandObjectVisualOffsetSensor::HandObjectVisualOffsetSensor(), iCubArmJointsSensor::iCubArmJointsSensor(), iCubFingertipsTouchSensor::iCubFingertipsTouchSensor(), iCubHandJointsSensor::iCubHandJointsSensor(), iCubHandTouchSensor::iCubHandTouchSensor(), iCubHeadJointsSensor::iCubHeadJointsSensor(), iCubPalmPatchesTouchSensor::iCubPalmPatchesTouchSensor(), iCubPalmTargetDistSensor::iCubPalmTargetDistSensor(), iCubPalmTouchSensor::iCubPalmTouchSensor(), iCubSensor::iCubSensor(), iCubTorsoJointsSensor::iCubTorsoJointsSensor(), iCubHandJointsSensor::resourceChanged(), iCubHeadJointsSensor::resourceChanged(), iCubTorsoJointsSensor::resourceChanged(), iCubPalmTouchSensor::resourceChanged(), iCubPalmTargetDistSensor::resourceChanged(), iCubArmJointsSensor::resourceChanged(), iCubSensor::save(), iCubPalmTargetDistSensor::update(), and ColorCameraSensor::update().

QString neuronsIteratorResource [protected]

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

Definition at line 117 of file icubsensors.h.

Referenced by ColorCameraSensor::ColorCameraSensor(), HandObjectVisualOffsetSensor::HandObjectVisualOffsetSensor(), iCubArmJointsSensor::iCubArmJointsSensor(), iCubFingertipsTouchSensor::iCubFingertipsTouchSensor(), iCubHandJointsSensor::iCubHandJointsSensor(), iCubHandTouchSensor::iCubHandTouchSensor(), iCubHeadJointsSensor::iCubHeadJointsSensor(), iCubPalmPatchesTouchSensor::iCubPalmPatchesTouchSensor(), iCubPalmTargetDistSensor::iCubPalmTargetDistSensor(), iCubPalmTouchSensor::iCubPalmTouchSensor(), iCubSensor::iCubSensor(), iCubTorsoJointsSensor::iCubTorsoJointsSensor(), iCubHandJointsSensor::resourceChanged(), iCubHeadJointsSensor::resourceChanged(), iCubTorsoJointsSensor::resourceChanged(), iCubPalmTouchSensor::resourceChanged(), iCubPalmTargetDistSensor::resourceChanged(), iCubArmJointsSensor::resourceChanged(), iCubSensor::save(), HandObjectVisualOffsetSensor::update(), iCubPalmPatchesTouchSensor::update(), iCubFingertipsTouchSensor::update(), iCubHandJointsSensor::update(), iCubHeadJointsSensor::update(), iCubTorsoJointsSensor::update(), iCubHandTouchSensor::update(), iCubPalmTouchSensor::update(), iCubPalmTargetDistSensor::update(), ColorCameraSensor::update(), and iCubArmJointsSensor::update().

---

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

• experiments/include/icubsensors.h
• experiments/src/icubsensors.cpp