MarXbotProximityIRSensor Class Reference

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

Inheritance diagram for MarXbotProximityIRSensor:

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.
Public Member Functions inherited from MarXbotSensor
	MarXbotSensor (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~MarXbotSensor ()
	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	setName (QString name)
	Use this method for changing the name of the Sensor.
Public Member Functions inherited from NoisyDevice
	NoisyDevice (ConfigurationParameters &params, QString prefix)
	Constructor and Configure.
	~NoisyDevice ()
	Destructor.
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 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.

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 MarXbotSensor
virtual void	resourceChanged (QString resourceName, ResourceChangeType changeType)
	The function called when a resource used here is changed.
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 MarXbotSensor
QString	m_marxbotResource
	The name of the resource associated with the MarXbot robot.
QString	m_neuronsIteratorResource
	The name of th resource associated with the neural network iterator.

Detailed Description

The infrared proximity sensors of the MarXbot.

The infrared proximity sensors of the MarXbot. This version of the infrared proximity sensors works with all Worldsim objects, but it is a bit slow. This sensor applies noise if requested

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

• activeSensors: Which IR sensors of the robot are actually enabled. This is a string of exactly 24 elements. Each element can be either "0" or "1" to respectively disable/enable the corresponding proximity IR sensor. The first sensor is the one on the left side of the robot and the others follow counterclockwise (i.e. left, back, right, front)

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

Definition at line 139 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 89 of file marxbotsensors.cpp.

References ConfigurationParameters::getValue(), and ConfigurationHelper::throwUserConfigError().

~MarXbotProximityIRSensor ( )

virtual

Destructor.

Definition at line 101 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 120 of file marxbotsensors.cpp.

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

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 106 of file marxbotsensors.cpp.

References ConfigurationParameters::createParameter(), and 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 147 of file marxbotsensors.cpp.

void update ( )

virtual

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

Implements Sensor.

Definition at line 130 of file marxbotsensors.cpp.

References SimulatedIRProximitySensorController::activation(), NoisyDevice::applyNoise(), Sensor::checkAllNeededResourcesExist(), Sensor::name(), NeuronsIterator::nextNeuron(), PhyMarXbot::proximityIRSensorController(), NeuronsIterator::setCurrentBlock(), and NeuronsIterator::setInput().

---

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

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