argos::CEPuckProximityDefaultSensor Class Reference

#include <epuck_proximity_default_sensor.h>

Inheritance diagram for argos::CEPuckProximityDefaultSensor:
Collaboration diagram for argos::CEPuckProximityDefaultSensor:

Public Member Functions

 CEPuckProximityDefaultSensor ()
 
virtual ~CEPuckProximityDefaultSensor ()
 
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...
 
virtual Real CalculateReading (Real f_distance)
 Calculates the proximity reading when the closest occluding object is located as the given distance. 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_EPuckProximitySensor
 CCI_EPuckProximitySensor ()
 
virtual ~CCI_EPuckProximitySensor ()
 
const TReadingsGetReadings () 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...
 

Protected Attributes

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_EPuckProximitySensor
TReadings m_tReadings
 

Additional Inherited Members

- Public Types inherited from argos::CCI_EPuckProximitySensor
typedef std::vector< SReadingTReadings
 
- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 

Detailed Description

Definition at line 26 of file epuck_proximity_default_sensor.h.

Constructor & Destructor Documentation

◆ CEPuckProximityDefaultSensor()

argos::CEPuckProximityDefaultSensor::CEPuckProximityDefaultSensor ( )

Definition at line 24 of file epuck_proximity_default_sensor.cpp.

◆ ~CEPuckProximityDefaultSensor()

virtual argos::CEPuckProximityDefaultSensor::~CEPuckProximityDefaultSensor ( )
inlinevirtual

Definition at line 33 of file epuck_proximity_default_sensor.h.

Member Function Documentation

◆ CalculateReading()

Real argos::CEPuckProximityDefaultSensor::CalculateReading ( Real  f_distance)
virtual

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.

Definition at line 142 of file epuck_proximity_default_sensor.cpp.

◆ Init()

void argos::CEPuckProximityDefaultSensor::Init ( TConfigurationNode t_node)
virtual

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 52 of file epuck_proximity_default_sensor.cpp.

◆ IsShowRays()

bool argos::CEPuckProximityDefaultSensor::IsShowRays ( )
inline

Returns true if the rays must be shown in the GUI.

Returns
true if the rays must be shown in the GUI.

Definition at line 54 of file epuck_proximity_default_sensor.h.

◆ Reset()

void argos::CEPuckProximityDefaultSensor::Reset ( )
virtual

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 133 of file epuck_proximity_default_sensor.cpp.

◆ SetRobot()

void argos::CEPuckProximityDefaultSensor::SetRobot ( CComposableEntity c_entity)
virtual

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 epuck_proximity_default_sensor.cpp.

◆ SetShowRays()

void argos::CEPuckProximityDefaultSensor::SetShowRays ( bool  b_show_rays)
inline

Sets whether or not the rays must be shown in the GUI.

Parameters
b_show_raystrue if the rays must be shown, false otherwise

Definition at line 62 of file epuck_proximity_default_sensor.h.

◆ Update()

void argos::CEPuckProximityDefaultSensor::Update ( )
virtual

Updates the state of the entity associated to this sensor, if the sensor is currently enabled.

If it is disabled, then this function should do nothing.

Implements argos::CSimulatedSensor.

Definition at line 77 of file epuck_proximity_default_sensor.cpp.

Member Data Documentation

◆ m_bAddNoise

bool argos::CEPuckProximityDefaultSensor::m_bAddNoise
protected

Whether to add noise or not.

Definition at line 84 of file epuck_proximity_default_sensor.h.

◆ m_bShowRays

bool argos::CEPuckProximityDefaultSensor::m_bShowRays
protected

Flag to show rays in the simulator.

Definition at line 78 of file epuck_proximity_default_sensor.h.

◆ m_cNoiseRange

CRange<Real> argos::CEPuckProximityDefaultSensor::m_cNoiseRange
protected

Noise range.

Definition at line 87 of file epuck_proximity_default_sensor.h.

◆ m_cSpace

CSpace& argos::CEPuckProximityDefaultSensor::m_cSpace
protected

Reference to the space.

Definition at line 90 of file epuck_proximity_default_sensor.h.

◆ m_pcControllableEntity

CControllableEntity* argos::CEPuckProximityDefaultSensor::m_pcControllableEntity
protected

Reference to controllable entity associated to this sensor.

Definition at line 75 of file epuck_proximity_default_sensor.h.

◆ m_pcEmbodiedEntity

CEmbodiedEntity* argos::CEPuckProximityDefaultSensor::m_pcEmbodiedEntity
protected

Reference to embodied entity associated to this sensor.

Definition at line 69 of file epuck_proximity_default_sensor.h.

◆ m_pcProximityEntity

CProximitySensorEquippedEntity* argos::CEPuckProximityDefaultSensor::m_pcProximityEntity
protected

Reference to proximity sensor equipped entity associated to this sensor.

Definition at line 72 of file epuck_proximity_default_sensor.h.

◆ m_pcRNG

CRandom::CRNG* argos::CEPuckProximityDefaultSensor::m_pcRNG
protected

Random number generator.

Definition at line 81 of file epuck_proximity_default_sensor.h.