It returns 1 if the palm (right or left) touches the target object, 0 otherwise. More...

Inheritance diagram for iCubPalmTouchSensor:

Public Member Functions

 iCubPalmTouchSensor (ConfigurationParameters &params, QString prefix)
 Constructor and Configure.
 
 ~iCubPalmTouchSensor ()
 Destructor.
 
void save (ConfigurationParameters &params, QString prefix)
 Save the parameters of the iCubArmJointsSensor into the ConfigurationParameters.
 
int size ()
 Return the number of neurons on which the Sensor will set the input: 7.
 
void update ()
 Update the state of the Sensor every time step.
 
- Public Member Functions inherited from iCubSensor
 iCubSensor (ConfigurationParameters &params, QString prefix)
 Constructor.
 
virtual ~iCubSensor ()
 Destructor.
 
- Public Member Functions inherited from Sensor
 Sensor (ConfigurationParameters &params, QString prefix)
 Constructor and Configure.
 
 ~Sensor ()
 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)
 
getRuntimeParameter (QString paramName)
 
virtual ParameterSettableUIgetUIManager ()
 
 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)
 
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 iCubArmJointsSensor.
 
- Static Public Member Functions inherited from iCubSensor
static void describe (QString type)
 Describes all the parameters for this sensor.
 
- Static Public Member Functions inherited from Sensor
static void describe (QString type)
 Describe all the parameter for configuring the Sensor.
 
- 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 Attributes

QString icubPalm
 From which palm the touch is detected (string: left or right)
 
QVector< WObject * > * objects
 a pointer to read the objects within the world
 
WObjectwPalm
 from which palm the touch is detected (world object)
 
- Protected Attributes inherited from iCubSensor
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.
 

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(""))
 
static void setGraphicalEditor (QString type)
 

Detailed Description

It returns 1 if the palm (right or left) touches the target object, 0 otherwise.

Definition at line 310 of file icubsensors.h.

Constructor & Destructor Documentation

iCubPalmTouchSensor ( ConfigurationParameters params,
QString  prefix 
)

Constructor and Configure.

Parameters
paramsis the ConfigurationParameters containing the parameters
prefixis the path prefix to the paramters for this Sensor

Definition at line 573 of file icubsensors.cpp.

References ConfigurationHelper::getString(), iCubPalmTouchSensor::icubPalm, iCubSensor::icubResource, iCubSensor::neuronsIteratorResource, iCubPalmTouchSensor::objects, ConcurrentResourcesUser::usableResources(), and iCubPalmTouchSensor::wPalm.

Destructor.

Definition at line 617 of file icubsensors.cpp.

Member Function Documentation

void resourceChanged ( QString  resourceName,
ResourceChangeType  changeType 
)
protectedvirtual

The function called when a resource used here is changed.

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

Reimplemented from iCubSensor.

Definition at line 628 of file icubsensors.cpp.

References iCubPalmTouchSensor::icubPalm, iCubSensor::icubResource, Logger::info(), PhyiCub::leftArm(), Sensor::name(), iCubSensor::neuronsIteratorResource, NeuronsIterator::nextNeuron(), iCubPalmTouchSensor::objects, iCubSensor::resourceChanged(), PhyiCub::rightArm(), NeuronsIterator::setCurrentBlock(), NeuronsIterator::setGraphicProperties(), and iCubPalmTouchSensor::wPalm.

void save ( ConfigurationParameters params,
QString  prefix 
)
virtual

Save the parameters of the iCubArmJointsSensor into the ConfigurationParameters.

Parameters
paramsis the ConfigurationParameters where save the parameters
prefixis the path prefix for the parameters to save

Reimplemented from iCubSensor.

Definition at line 620 of file icubsensors.cpp.

References ConfigurationParameters::createParameter(), iCubPalmTouchSensor::icubPalm, iCubSensor::save(), and ConfigurationParameters::startObjectParameters().

int size ( )
virtual

Return the number of neurons on which the Sensor will set the input: 7.

Implements Sensor.

Definition at line 613 of file icubsensors.cpp.

Referenced by iCubPalmTouchSensor::update().

Member Data Documentation

QString icubPalm
protected

From which palm the touch is detected (string: left or right)

Definition at line 338 of file icubsensors.h.

Referenced by iCubPalmTouchSensor::iCubPalmTouchSensor(), iCubPalmTouchSensor::resourceChanged(), and iCubPalmTouchSensor::save().

QVector<WObject*>* objects
protected

a pointer to read the objects within the world

Definition at line 342 of file icubsensors.h.

Referenced by iCubPalmTouchSensor::iCubPalmTouchSensor(), iCubPalmTouchSensor::resourceChanged(), and iCubPalmTouchSensor::update().

WObject* wPalm
protected

from which palm the touch is detected (world object)

Definition at line 340 of file icubsensors.h.

Referenced by iCubPalmTouchSensor::iCubPalmTouchSensor(), iCubPalmTouchSensor::resourceChanged(), and iCubPalmTouchSensor::update().


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