#include <epuck_proximity_default_sensor.h>

Inheritance diagram for argos::CEPuckProximityDefaultSensor:

[legend]

Collaboration diagram for argos::CEPuckProximityDefaultSensor:

[legend]

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 TReadings &	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...

Protected Attributes
CEmbodiedEntity *	m_pcEmbodiedEntity
	Reference to embodied entity associated to this sensor. More...

CProximitySensorEquippedEntity *	m_pcProximityEntity
	Reference to proximity sensor equipped entity associated to this sensor. More...

CControllableEntity *	m_pcControllableEntity
	Reference to controllable entity associated to this sensor. More...

bool	m_bShowRays
	Flag to show rays in the simulator. More...

CRandom::CRNG *	m_pcRNG
	Random number generator. More...

bool	m_bAddNoise
	Whether to add noise or not. More...

CRange< Real >	m_cNoiseRange
	Noise range. More...

CSpace &	m_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< SReading >	TReadings

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_distance The 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_node The 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_entity The entity to associate to this sensor.