argos::CRangeAndBearingMediumSensor Class Reference

#include <range_and_bearing_medium_sensor.h>

Inheritance diagram for argos::CRangeAndBearingMediumSensor:
Collaboration diagram for argos::CRangeAndBearingMediumSensor:

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

argos::CRangeAndBearingMediumSensor::CRangeAndBearingMediumSensor ( )

Definition at line 24 of file range_and_bearing_medium_sensor.cpp.

virtual argos::CRangeAndBearingMediumSensor::~CRangeAndBearingMediumSensor ( )
inlinevirtual

Definition at line 33 of file range_and_bearing_medium_sensor.h.

Member Function Documentation

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 155 of file range_and_bearing_medium_sensor.cpp.

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

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 148 of file range_and_bearing_medium_sensor.cpp.

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_entityThe entity to associate to this sensor.
See also
CComposableEntity
CControllableEntity::SetController()
CCI_Sensor::Init()

Implements argos::CSimulatedSensor.

Definition at line 35 of file range_and_bearing_medium_sensor.cpp.

void argos::CRangeAndBearingMediumSensor::Update ( )
virtual

Updates the state of the entity associated to this sensor.

TODO: there's a more efficient way to implement this

Implements argos::CSimulatedSensor.

Definition at line 75 of file range_and_bearing_medium_sensor.cpp.