argos::CProximityDefaultSensor Class Reference

#include <proximity_default_sensor.h>

Inheritance diagram for argos::CProximityDefaultSensor:
Collaboration diagram for argos::CProximityDefaultSensor:

Public Member Functions

 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. 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...
 
- 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...
 
- 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_ProximitySensor
std::vector< Realm_tReadings
 

Additional Inherited Members

- 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 proximity_default_sensor.h.

Constructor & Destructor Documentation

argos::CProximityDefaultSensor::CProximityDefaultSensor ( )

Definition at line 24 of file proximity_default_sensor.cpp.

virtual argos::CProximityDefaultSensor::~CProximityDefaultSensor ( )
inlinevirtual

Definition at line 33 of file proximity_default_sensor.h.

Member Function Documentation

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

Reimplemented in argos::CProximitySensorImpl, and argos::CProximitySensorImpl.

Definition at line 133 of file proximity_default_sensor.cpp.

void argos::CProximityDefaultSensor::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 49 of file proximity_default_sensor.cpp.

void argos::CProximityDefaultSensor::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 124 of file proximity_default_sensor.cpp.

void argos::CProximityDefaultSensor::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 proximity_default_sensor.cpp.

void argos::CProximityDefaultSensor::Update ( )
virtual

Updates the state of the entity associated to this sensor.

Implements argos::CSimulatedSensor.

Definition at line 75 of file proximity_default_sensor.cpp.

Member Data Documentation

bool argos::CProximityDefaultSensor::m_bAddNoise
protected

Whether to add noise or not.

Definition at line 68 of file proximity_default_sensor.h.

bool argos::CProximityDefaultSensor::m_bShowRays
protected

Flag to show rays in the simulator.

Definition at line 62 of file proximity_default_sensor.h.

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

Noise range.

Definition at line 71 of file proximity_default_sensor.h.

CSpace& argos::CProximityDefaultSensor::m_cSpace
protected

Reference to the space.

Definition at line 74 of file proximity_default_sensor.h.

CControllableEntity* argos::CProximityDefaultSensor::m_pcControllableEntity
protected

Reference to controllable entity associated to this sensor.

Definition at line 59 of file proximity_default_sensor.h.

CEmbodiedEntity* argos::CProximityDefaultSensor::m_pcEmbodiedEntity
protected

Reference to embodied entity associated to this sensor.

Definition at line 53 of file proximity_default_sensor.h.

CProximitySensorEquippedEntity* argos::CProximityDefaultSensor::m_pcProximityEntity
protected

Reference to proximity sensor equipped entity associated to this sensor.

Definition at line 56 of file proximity_default_sensor.h.

CRandom::CRNG* argos::CProximityDefaultSensor::m_pcRNG
protected

Random number generator.

Definition at line 65 of file proximity_default_sensor.h.