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. More...
 
virtual void Reset ()
 Resets the sensor to the state it had just after Init(). 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::TVectorGetInterfaces () 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...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Protected Attributes

CRadioEquippedEntitym_pcRadioEquippedEntity
 
CControllableEntitym_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

argos::CRadiosDefaultSensor::CRadiosDefaultSensor ( )

Definition at line 15 of file radios_default_sensor.cpp.

virtual argos::CRadiosDefaultSensor::~CRadiosDefaultSensor ( )
inlinevirtual

Definition at line 27 of file radios_default_sensor.h.

Member Function Documentation

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_nodeThe XML configuration tree relative to this sensor.
See also
Reset()
Destroy()

Reimplemented from argos::CCI_Sensor.

Definition at line 46 of file radios_default_sensor.cpp.

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 82 of file radios_default_sensor.cpp.

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_entityThe 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.

void argos::CRadiosDefaultSensor::Update ( )
virtual

Updates the state of the entity associated to this sensor.

Implements argos::CSimulatedSensor.

Definition at line 61 of file radios_default_sensor.cpp.

Member Data Documentation

bool argos::CRadiosDefaultSensor::m_bShowRays
protected

Definition at line 41 of file radios_default_sensor.h.

CControllableEntity* argos::CRadiosDefaultSensor::m_pcControllableEntity
protected

Definition at line 40 of file radios_default_sensor.h.

CRadioEquippedEntity* argos::CRadiosDefaultSensor::m_pcRadioEquippedEntity
protected

Definition at line 39 of file radios_default_sensor.h.