argos::CProximitySensorImpl Class Reference
Inheritance diagram for argos::CProximitySensorImpl:
Collaboration diagram for argos::CProximitySensorImpl:

Public Member Functions

virtual Real CalculateReading (Real f_distance)
 Calculates the proximity reading when the closest occluding object is located as the given distance. More...
 
virtual Real CalculateReading (Real f_distance)
 Calculates the proximity reading when the closest occluding object is located as the given distance. More...
 
- Public Member Functions inherited from argos::CProximityDefaultSensor
 CProximityDefaultSensor ()
 
virtual ~CProximityDefaultSensor ()
 
virtual void SetRobot (CComposableEntity &c_entity)
 Sets the entity associated to this sensor. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the sensor from the XML configuration tree. More...
 
virtual void Update ()
 Updates the state of the entity associated to this sensor, if the sensor is currently enabled. More...
 
virtual void Reset ()
 Resets the sensor to the state it had just after Init(). More...
 
bool IsShowRays ()
 Returns true if the rays must be shown in the GUI. More...
 
void SetShowRays (bool b_show_rays)
 Sets whether or not the rays must be shown in the GUI. More...
 
- Public Member Functions inherited from argos::CSimulatedSensor
virtual ~CSimulatedSensor ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CCI_ProximitySensor
virtual ~CCI_ProximitySensor ()
 
const std::vector< Real > & GetReadings () const
 
- Public Member Functions inherited from argos::CCI_Sensor
virtual ~CCI_Sensor ()
 Class destructor. More...
 
virtual void Destroy ()
 Destroys the sensor. More...
 
virtual void Enable ()
 Enables updating of sensor information in the event loop. More...
 
virtual void Disable ()
 Disables updating of sensor information in the event loop. More...
 
bool IsEnabled () const
 
bool IsDisabled () const
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Additional Inherited Members

- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 
- Protected Attributes inherited from argos::CProximityDefaultSensor
CEmbodiedEntitym_pcEmbodiedEntity
 Reference to embodied entity associated to this sensor. More...
 
CProximitySensorEquippedEntitym_pcProximityEntity
 Reference to proximity sensor equipped entity associated to this sensor. More...
 
CControllableEntitym_pcControllableEntity
 Reference to controllable entity associated to this sensor. More...
 
bool m_bShowRays
 Flag to show rays in the simulator. More...
 
CRandom::CRNGm_pcRNG
 Random number generator. More...
 
bool m_bAddNoise
 Whether to add noise or not. More...
 
CRange< Realm_cNoiseRange
 Noise range. More...
 
CSpacem_cSpace
 Reference to the space. More...
 
- Protected Attributes inherited from argos::CCI_ProximitySensor
std::vector< Realm_tReadings
 

Detailed Description

Definition at line 18 of file eyebot_proximity_default_sensor.cpp.

Member Function Documentation

◆ CalculateReading() [1/2]

virtual Real argos::CProximitySensorImpl::CalculateReading ( Real  f_distance)
inlinevirtual

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 from argos::CProximityDefaultSensor.

Definition at line 22 of file eyebot_proximity_default_sensor.cpp.

◆ CalculateReading() [2/2]

virtual Real argos::CProximitySensorImpl::CalculateReading ( Real  f_distance)
inlinevirtual

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 from argos::CProximityDefaultSensor.

Definition at line 22 of file footbot_proximity_default_sensor.cpp.