MarXbotSensor Class Reference

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

Inheritance diagram for MarXbotSensor:

List of all members.

Public Member Functions
	MarXbotSensor (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~MarXbotSensor ()
	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	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 base abstract class for MarXbot sensors.

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

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

• marxbot: the name of the resource associated with the MarXbot 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 marxbot parameter: the simulated physical MarXbot robot
• name defined by the neuronsIterator parameter: the object to iterate over neurons of the neural network

Definition at line 53 of file marxbotsensors.h.

---

Constructor & Destructor Documentation

MarXbotSensor	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

This also reads configuration parameters. Moreover this adds the MarXbot 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 31 of file marxbotsensors.cpp.

References ConfigurationHelper::getString(), MarXbotSensor::m_marxbotResource, MarXbotSensor::m_neuronsIteratorResource, and ConcurrentResourcesUser::usableResources().

~MarXbotSensor

(

)

[virtual]

Destructor.

Definition at line 44 of file marxbotsensors.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 MarXbotProximityIRSensor, MarXbotGroundBottomIRSensor, and MarXbotGroundAroundIRSensor.

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

Definition at line 71 of file marxbotsensors.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 MarXbotProximityIRSensor, MarXbotGroundBottomIRSensor, and MarXbotGroundAroundIRSensor.

Definition at line 49 of file marxbotsensors.cpp.

References ConfigurationParameters::createParameter(), MarXbotSensor::m_marxbotResource, MarXbotSensor::m_neuronsIteratorResource, and ConfigurationParameters::startObjectParameters().

---

Member Data Documentation

QString m_marxbotResource [protected]

The name of the resource associated with the MarXbot robot.

Definition at line 105 of file marxbotsensors.h.

Referenced by MarXbotSensor::MarXbotSensor(), and MarXbotSensor::save().

QString m_neuronsIteratorResource [protected]

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

Definition at line 111 of file marxbotsensors.h.

Referenced by MarXbotSensor::MarXbotSensor(), and MarXbotSensor::save().

---

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

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