ARGoS  3
A parallel, multi-engine simulator for swarm robotics
argos::CProximityDefaultSensor Class Reference

#include <proximity_default_sensor.h>

+ Inheritance diagram for argos::CProximityDefaultSensor:

List of all members.

Public Member Functions

 CProximityDefaultSensor ()
virtual ~CProximityDefaultSensor ()
virtual void SetRobot (CComposableEntity &c_entity)
 Sets the entity associated to this sensor.
virtual void Init (TConfigurationNode &t_tree)
 Initializes the sensor from the XML configuration tree.
virtual void Update ()
 Updates the state of the entity associated to this sensor.
virtual void Reset ()
 Resets the sensor to the state it had just after Init().
virtual Real CalculateReading (Real f_distance)
 Calculates the proximity reading when the closest occluding object is located as the given distance.

Protected Attributes

CEmbodiedEntitym_pcEmbodiedEntity
 Reference to embodied entity associated to this sensor.
CProximitySensorEquippedEntitym_pcProximityEntity
 Reference to proximity sensor equipped entity associated to this sensor.
CControllableEntitym_pcControllableEntity
 Reference to controllable entity associated to this sensor.
bool m_bShowRays
 Flag to show rays in the simulator.
CRandom::CRNGm_pcRNG
 Random number generator.
bool m_bAddNoise
 Whether to add noise or not.
CRange< Realm_cNoiseRange
 Noise range.
CSpacem_cSpace
 Reference to the space.

Detailed Description

Definition at line 26 of file proximity_default_sensor.h.


Constructor & Destructor Documentation

Definition at line 33 of file proximity_default_sensor.h.


Member Function Documentation

Calculates the proximity reading when the closest occluding object is located as the given distance.

Parameters:
f_distanceThe distance of the closest occluding object in meters
Returns:
A value in the range [0:1], where 0 means that the object is too far to be sensed, and 1 means the object is so close that it saturates the sensor.

Reimplemented in argos::CProximitySensorImpl.

Definition at line 134 of file proximity_default_sensor.cpp.

Initializes the sensor from the XML configuration tree.

The default implementation of this method does nothing.

Parameters:
t_nodeThe XML configuration tree relative to this sensor.
See also:
Reset()
Destroy()

Reimplemented from argos::CCI_Sensor.

Definition at line 50 of file proximity_default_sensor.cpp.

Resets the sensor to the state it had just after Init().

The default implementation of this method does nothing.

See also:
Init()
Destroy()

Reimplemented from argos::CCI_Sensor.

Definition at line 125 of file proximity_default_sensor.cpp.

Sets the entity associated to this sensor.

When a controller is created, all the sensors and actuators are created, too. This function is called right before the Init() method of the sensor is called.

Parameters:
c_entityThe entity to associate to this sensor.
See also:
CComposableEntity
CControllableEntity::SetController()
CCI_Sensor::Init()

Implements argos::CSimulatedSensor.

Definition at line 34 of file proximity_default_sensor.cpp.

Updates the state of the entity associated to this sensor.

Implements argos::CSimulatedSensor.

Definition at line 76 of file proximity_default_sensor.cpp.


Member Data Documentation

Whether to add noise or not.

Definition at line 68 of file proximity_default_sensor.h.

Flag to show rays in the simulator.

Definition at line 62 of file proximity_default_sensor.h.

Noise range.

Definition at line 71 of file proximity_default_sensor.h.

Reference to the space.

Definition at line 74 of file proximity_default_sensor.h.

Reference to controllable entity associated to this sensor.

Definition at line 59 of file proximity_default_sensor.h.

Reference to embodied entity associated to this sensor.

Definition at line 53 of file proximity_default_sensor.h.

Reference to proximity sensor equipped entity associated to this sensor.

Definition at line 56 of file proximity_default_sensor.h.

Random number generator.

Definition at line 65 of file proximity_default_sensor.h.


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