argos::CFootBotDistanceScannerRotZOnlySensor Class Reference

#include <footbot_distance_scanner_rotzonly_sensor.h>

Inheritance diagram for argos::CFootBotDistanceScannerRotZOnlySensor:
Collaboration diagram for argos::CFootBotDistanceScannerRotZOnlySensor:

Public Member Functions

 CFootBotDistanceScannerRotZOnlySensor ()
 
virtual ~CFootBotDistanceScannerRotZOnlySensor ()
 
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...
 
- Public Member Functions inherited from argos::CSimulatedSensor
virtual ~CSimulatedSensor ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CCI_FootBotDistanceScannerSensor
 CCI_FootBotDistanceScannerSensor ()
 Constructor. More...
 
virtual ~CCI_FootBotDistanceScannerSensor ()
 Destructor. More...
 
const TReadingsMapGetReadingsMap ()
 Return a map of the readings of the ds A map of the readings of the ds in the following format: angle - value. More...
 
const TReadingsMapGetShortReadingsMap ()
 Return a map of the readings of the ds, short sensor readings A map of the readings of the ds short sensor readings in the following format: angle - value. More...
 
const TReadingsMapGetLongReadingsMap ()
 Return a map of the readings of the ds, long sensor readings A map of the readings of the ds long sensor readings in the following format: angle - value. 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...
 

Additional Inherited Members

- Public Types inherited from argos::CCI_FootBotDistanceScannerSensor
typedef std::vector< SReadingTReadings
 
typedef std::vector< TReadingsTLastReadings
 
typedef std::pair< CRadians, RealTMapPair
 
typedef std::map< CRadians, RealTReadingsMap
 
- 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_FootBotDistanceScannerSensor
TReadings m_tReadings
 A vector of sReadings. More...
 
TLastReadings m_tLastReadings
 Vector storing the last received packets. More...
 
TReadingsMap m_tReadingsMap
 Map storing all the last received packets. More...
 
TReadingsMap m_tShortReadingsMap
 Map storing the last received packets from the short distance sensors. More...
 
TReadingsMap m_tLongReadingsMap
 Map storing the last received packets from the long distance sensors. More...
 

Detailed Description

Definition at line 28 of file footbot_distance_scanner_rotzonly_sensor.h.

Constructor & Destructor Documentation

◆ CFootBotDistanceScannerRotZOnlySensor()

argos::CFootBotDistanceScannerRotZOnlySensor::CFootBotDistanceScannerRotZOnlySensor ( )

Definition at line 33 of file footbot_distance_scanner_rotzonly_sensor.cpp.

◆ ~CFootBotDistanceScannerRotZOnlySensor()

virtual argos::CFootBotDistanceScannerRotZOnlySensor::~CFootBotDistanceScannerRotZOnlySensor ( )
inlinevirtual

Definition at line 35 of file footbot_distance_scanner_rotzonly_sensor.h.

Member Function Documentation

◆ Init()

void argos::CFootBotDistanceScannerRotZOnlySensor::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 42 of file footbot_distance_scanner_rotzonly_sensor.cpp.

◆ Reset()

void argos::CFootBotDistanceScannerRotZOnlySensor::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 111 of file footbot_distance_scanner_rotzonly_sensor.cpp.

◆ SetRobot()

void argos::CFootBotDistanceScannerRotZOnlySensor::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 65 of file footbot_distance_scanner_rotzonly_sensor.cpp.

◆ Update()

void argos::CFootBotDistanceScannerRotZOnlySensor::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 75 of file footbot_distance_scanner_rotzonly_sensor.cpp.