MarXbotGroundBottomIRSensor Class Reference

The infrared ground bottom sensors of the MarXbot. More...

Inheritance diagram for MarXbotGroundBottomIRSensor:

Public Member Functions

 MarXbotGroundBottomIRSensor (ConfigurationParameters &params, QString prefix)
 Constructor.
 
virtual ~MarXbotGroundBottomIRSensor ()
 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 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)
 Generates a description of this class and its parameters.
 
- Static Public Member Functions inherited from MarXbotSensor
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)
 

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 Sensor
QString actualResourceNameForMultirobot (QString resourceName) const
 Returns the actual resource name to use.
 
void checkAllNeededResourcesExist ()
 Checks whether all resources we need are existing and throws an exception if they aren't.
 
void resetNeededResourcesCheck ()
 Resets the check on needed resources so that the next call to checkAllNeededResourcesExist() will perform the full check and not the quick one.
 
- 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 ground bottom sensors of the MarXbot.

The infrared ground sensors below the battery pack of the MarXbot. This version of the infrared ground bottom sensors works with all Worldsim objects, but it is a bit slow.

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 230 of file marxbotsensors.h.

Constructor & Destructor Documentation

MarXbotGroundBottomIRSensor ( ConfigurationParameters params,
QString  prefix 
)

Constructor.

Creates and configures the sensor

Parameters
paramsthe ConfigurationParameters containing the parameters
prefixthe path prefix to the paramters for this Sensor

Definition at line 184 of file marxbotsensors.cpp.

Destructor.

Definition at line 191 of file marxbotsensors.cpp.

Member Function Documentation

void describe ( QString  type)
static

Generates a description of this class and its parameters.

Parameters
typethe string representation of this class name

Definition at line 205 of file marxbotsensors.cpp.

References ParameterSettableInConstructor::addTypeDescription(), and MarXbotSensor::describe().

void save ( ConfigurationParameters params,
QString  prefix 
)
virtual

Saves current parameters into the given ConfigurationParameters object.

Parameters
paramsthe ConfigurationParameters object in which parameters should be saved
prefixthe name and path of the group where to save parametrs

Reimplemented from MarXbotSensor.

Definition at line 196 of file marxbotsensors.cpp.

References MarXbotSensor::save(), 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 228 of file marxbotsensors.cpp.

Referenced by MarXbotGroundBottomIRSensor::update().


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