argos::CFootBotTurretEncoderDefaultSensor Class Reference

#include <footbot_turret_encoder_default_sensor.h>

Inheritance diagram for argos::CFootBotTurretEncoderDefaultSensor:
Collaboration diagram for argos::CFootBotTurretEncoderDefaultSensor:

Public Member Functions

 CFootBotTurretEncoderDefaultSensor ()
 
virtual ~CFootBotTurretEncoderDefaultSensor ()
 
virtual void SetRobot (CComposableEntity &c_entity)
 Sets the entity associated to this sensor. 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 Enable ()
 Enables updating of sensor information in the event loop. More...
 
virtual void Disable ()
 Disables updating of sensor information in the event loop. More...
 
- Public Member Functions inherited from argos::CCI_FootBotTurretEncoderSensor
virtual ~CCI_FootBotTurretEncoderSensor ()
 
const CRadiansGetRotation () const
 
- Public Member Functions inherited from argos::CCI_Sensor
virtual ~CCI_Sensor ()
 Class destructor. More...
 
virtual void Init (TConfigurationNode &t_node)
 Initializes the sensor from the XML configuration tree. More...
 
virtual void Destroy ()
 Destroys the sensor. More...
 
bool IsEnabled () const
 
bool IsDisabled () const
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CSimulatedSensor
virtual ~CSimulatedSensor ()
 Class destructor. More...
 

Additional Inherited Members

- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 
- Static Public Attributes inherited from argos::CCI_FootBotTurretEncoderSensor
static const CRange< CRadiansANGULAR_RANGE
 
- Protected Attributes inherited from argos::CCI_FootBotTurretEncoderSensor
CRadians m_cRotation
 

Detailed Description

Definition at line 24 of file footbot_turret_encoder_default_sensor.h.

Constructor & Destructor Documentation

◆ CFootBotTurretEncoderDefaultSensor()

argos::CFootBotTurretEncoderDefaultSensor::CFootBotTurretEncoderDefaultSensor ( )

Definition at line 15 of file footbot_turret_encoder_default_sensor.cpp.

◆ ~CFootBotTurretEncoderDefaultSensor()

virtual argos::CFootBotTurretEncoderDefaultSensor::~CFootBotTurretEncoderDefaultSensor ( )
inlinevirtual

Definition at line 31 of file footbot_turret_encoder_default_sensor.h.

Member Function Documentation

◆ Disable()

void argos::CFootBotTurretEncoderDefaultSensor::Disable ( )
virtual

Disables updating of sensor information in the event loop.

Reimplemented from argos::CCI_Sensor.

Definition at line 50 of file footbot_turret_encoder_default_sensor.cpp.

◆ Enable()

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

◆ Reset()

void argos::CFootBotTurretEncoderDefaultSensor::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 58 of file footbot_turret_encoder_default_sensor.cpp.

◆ SetRobot()

void argos::CFootBotTurretEncoderDefaultSensor::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 21 of file footbot_turret_encoder_default_sensor.cpp.

◆ Update()

void argos::CFootBotTurretEncoderDefaultSensor::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 31 of file footbot_turret_encoder_default_sensor.cpp.