MarXbotProximityIRSensor Class Reference

The infrared proximity sensors of the MarXbot. More...

Inheritance diagram for MarXbotProximityIRSensor:

List of all members.

Public Member Functions
	MarXbotProximityIRSensor (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~MarXbotProximityIRSensor ()
	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 sensor.
virtual void	update ()
	Performs the sensor update. This also modifies the activation of input neurons.
Static Public Member Functions
static void	describe (QString type)
	Generates a description of this class and its parameters.

---

Detailed Description

The infrared proximity sensors of the MarXbot.

The infrared proximity sensors of the MarXbot

This class does not add any other parameter to those defined by the parent class (MarXbotSensor)

The resources required by this Sensor are the same as those of the parent class

Definition at line 125 of file marxbotsensors.h.

---

Constructor & Destructor Documentation

MarXbotProximityIRSensor	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

Creates and configures the sensor

Parameters:

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

Definition at line 84 of file marxbotsensors.cpp.

~MarXbotProximityIRSensor

(

)

[virtual]

Destructor.

Definition at line 91 of file marxbotsensors.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

Reimplemented from MarXbotSensor.

Definition at line 105 of file marxbotsensors.cpp.

References ParameterSettable::addTypeDescription().

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 MarXbotSensor.

Definition at line 96 of file marxbotsensors.cpp.

References ConfigurationParameters::startObjectParameters().

int size

(

)

[virtual]

Returns the number of neurons required by this sensor.

Returns:

the number of neurons required by this sensor

Implements Sensor.

Definition at line 128 of file marxbotsensors.cpp.

Referenced by MarXbotProximityIRSensor::update().

void update

(

)

[virtual]

Performs the sensor update. This also modifies the activation of input neurons.

Implements Sensor.

Definition at line 114 of file marxbotsensors.cpp.

References IRSensorController::activation(), Sensor::checkAllNeededResourcesExist(), Sensor::name(), NeuronsIterator::nextNeuron(), PhyMarXbot::proximityIRSensorController(), NeuronsIterator::setCurrentBlock(), NeuronsIterator::setInput(), and MarXbotProximityIRSensor::size().

---

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

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