argos::CRadiosDefaultSensor Class Reference

#include <radios_default_sensor.h>

Inheritance diagram for argos::CRadiosDefaultSensor:

Collaboration diagram for argos::CRadiosDefaultSensor:

Public Member Functions
	CRadiosDefaultSensor ()
virtual	~CRadiosDefaultSensor ()
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_RadiosSensor
	CCI_RadiosSensor ()
	Constructor. More...
virtual	~CCI_RadiosSensor ()
	Destructor. More...
const SInterface::TVector &	GetInterfaces () const
	Returns a const reference to the radio interfaces. More...
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
CRadioEquippedEntity *	m_pcRadioEquippedEntity
CControllableEntity *	m_pcControllableEntity
bool	m_bShowRays
Protected Attributes inherited from argos::CCI_RadiosSensor
SInterface::TVector	m_vecInterfaces

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 20 of file radios_default_sensor.h.

Constructor & Destructor Documentation

CRadiosDefaultSensor()

argos::CRadiosDefaultSensor::CRadiosDefaultSensor

(

)

Definition at line 15 of file radios_default_sensor.cpp.

~CRadiosDefaultSensor()

virtual argos::CRadiosDefaultSensor::~CRadiosDefaultSensor ( )

inlinevirtual

Definition at line 27 of file radios_default_sensor.h.

Member Function Documentation

Init()

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

IsShowRays()

bool argos::CRadiosDefaultSensor::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 41 of file radios_default_sensor.h.

Reset()

void argos::CRadiosDefaultSensor::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 89 of file radios_default_sensor.cpp.

SetRobot()

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

See also

CComposableEntity

CControllableEntity::SetController()

CCI_Sensor::Init()

Implements argos::CSimulatedSensor.

Definition at line 23 of file radios_default_sensor.cpp.

SetShowRays()

void argos::CRadiosDefaultSensor::SetShowRays ( bool  b_show_rays )

inline

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

Parameters

b_show_rays

true if the rays must be shown, false otherwise

Definition at line 49 of file radios_default_sensor.h.

Update()

void argos::CRadiosDefaultSensor::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 64 of file radios_default_sensor.cpp.

Member Data Documentation

m_bShowRays

bool argos::CRadiosDefaultSensor::m_bShowRays

protected

Definition at line 57 of file radios_default_sensor.h.

m_pcControllableEntity

CControllableEntity* argos::CRadiosDefaultSensor::m_pcControllableEntity

protected

Definition at line 56 of file radios_default_sensor.h.

m_pcRadioEquippedEntity

CRadioEquippedEntity* argos::CRadiosDefaultSensor::m_pcRadioEquippedEntity

protected

Definition at line 55 of file radios_default_sensor.h.