argos::CCI_FootBotEncoderSensor Class Reference

#include <ci_footbot_encoder_sensor.h>

Inheritance diagram for argos::CCI_FootBotEncoderSensor:
Collaboration diagram for argos::CCI_FootBotEncoderSensor:

Classes

struct  SReading
 The DTO of the encoder It returns the distance covered by the wheels in the last timestep In addition it returns the value of the interaxis distance. More...
 

Public Member Functions

virtual ~CCI_FootBotEncoderSensor ()
 Destructor. More...
 
const SReadingGetReading () const
 Returns the reading of the encoder sensor Returns the reading of the encoder sensor. More...
 
- 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 Reset ()
 Resets the sensor to the state it had just after Init(). 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

SReading m_sReading
 

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 28 of file ci_footbot_encoder_sensor.h.

Constructor & Destructor Documentation

◆ ~CCI_FootBotEncoderSensor()

virtual argos::CCI_FootBotEncoderSensor::~CCI_FootBotEncoderSensor ( )
inlinevirtual

Destructor.

Definition at line 62 of file ci_footbot_encoder_sensor.h.

Member Function Documentation

◆ GetReading()

const CCI_FootBotEncoderSensor::SReading & argos::CCI_FootBotEncoderSensor::GetReading ( ) const

Returns the reading of the encoder sensor Returns the reading of the encoder sensor.

Definition at line 18 of file ci_footbot_encoder_sensor.cpp.

Member Data Documentation

◆ m_sReading

SReading argos::CCI_FootBotEncoderSensor::m_sReading
protected

Definition at line 78 of file ci_footbot_encoder_sensor.h.