#include <range_and_bearing_medium_sensor.h>

Inheritance diagram for argos::CRangeAndBearingMediumSensor:

[legend]

Collaboration diagram for argos::CRangeAndBearingMediumSensor:

[legend]

Public Member Functions
	CRangeAndBearingMediumSensor ()

virtual	~CRangeAndBearingMediumSensor ()

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 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	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_RangeAndBearingSensor
virtual	~CCI_RangeAndBearingSensor ()

const TReadings &	GetReadings () const

Public Member Functions inherited from argos::CCI_Sensor
virtual	~CCI_Sensor ()
	Class destructor. 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_RangeAndBearingSensor
typedef std::vector< SPacket >	TReadings

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

Protected Attributes inherited from argos::CCI_RangeAndBearingSensor
TReadings	m_tReadings

Detailed Description

Definition at line 27 of file range_and_bearing_medium_sensor.h.

Constructor & Destructor Documentation

◆ CRangeAndBearingMediumSensor()

argos::CRangeAndBearingMediumSensor::CRangeAndBearingMediumSensor ( )

Definition at line 24 of file range_and_bearing_medium_sensor.cpp.

◆ ~CRangeAndBearingMediumSensor()

virtual argos::CRangeAndBearingMediumSensor::~CRangeAndBearingMediumSensor ( )

inlinevirtual

Definition at line 33 of file range_and_bearing_medium_sensor.h.

Member Function Documentation

◆ Destroy()

void argos::CRangeAndBearingMediumSensor::Destroy ( )

virtual

Destroys the sensor.

This method is supposed to undo whatever was done in Init(). The default implementation of this method does nothing.

See also: Init(); Reset()

Reimplemented from argos::CCI_Sensor.

Definition at line 175 of file range_and_bearing_medium_sensor.cpp.

◆ Disable()

void argos::CRangeAndBearingMediumSensor::Disable ( )

virtual

Disables updating of sensor information in the event loop.

Reimplemented from argos::CCI_Sensor.

Definition at line 167 of file range_and_bearing_medium_sensor.cpp.

◆ Enable()

void argos::CRangeAndBearingMediumSensor::Enable ( )

virtual

Enables updating of sensor information in the event loop.

For some sensors, this must be called before using them, others are enabled by default.

Reimplemented from argos::CCI_Sensor.

Definition at line 159 of file range_and_bearing_medium_sensor.cpp.

◆ Init()

void argos::CRangeAndBearingMediumSensor::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 45 of file range_and_bearing_medium_sensor.cpp.

◆ IsShowRays()

bool argos::CRangeAndBearingMediumSensor::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 53 of file range_and_bearing_medium_sensor.h.

◆ Reset()

void argos::CRangeAndBearingMediumSensor::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 152 of file range_and_bearing_medium_sensor.cpp.

◆ SetRobot()

void argos::CRangeAndBearingMediumSensor::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.