argos::CFootBotLightRotZOnlySensor Class Reference

#include <footbot_light_rotzonly_sensor.h>

Inheritance diagram for argos::CFootBotLightRotZOnlySensor:
Collaboration diagram for argos::CFootBotLightRotZOnlySensor:

Public Member Functions

 CFootBotLightRotZOnlySensor ()
 
virtual ~CFootBotLightRotZOnlySensor ()
 
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...
 
bool IsShowRays ()
 Returns true if the rays must be shown in the GUI. More...
 
void SetShowRays (bool b_show_rays)
 Sets whether or not the rays must be shown in the GUI. More...
 
- Public Member Functions inherited from argos::CSimulatedSensor
virtual ~CSimulatedSensor ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CCI_FootBotLightSensor
 CCI_FootBotLightSensor ()
 
virtual ~CCI_FootBotLightSensor ()
 
const TReadingsGetReadings () const
 Returns the readings of this sensor. 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...
 

Protected Attributes

CEmbodiedEntitym_pcEmbodiedEntity
 Reference to embodied entity associated to this sensor. More...
 
CLightSensorEquippedEntitym_pcLightEntity
 Reference to light sensor equipped entity associated to this sensor. More...
 
CControllableEntitym_pcControllableEntity
 Reference to controllable entity associated to this sensor. More...
 
bool m_bShowRays
 Flag to show rays in the simulator. More...
 
CRandom::CRNGm_pcRNG
 Random number generator. More...
 
bool m_bAddNoise
 Whether to add noise or not. More...
 
CRange< Realm_cNoiseRange
 Noise range. More...
 
CSpacem_cSpace
 Reference to the space. More...
 
- Protected Attributes inherited from argos::CCI_FootBotLightSensor
TReadings m_tReadings
 

Additional Inherited Members

- Public Types inherited from argos::CCI_FootBotLightSensor
typedef std::vector< SReadingTReadings
 
- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 

Detailed Description

Definition at line 26 of file footbot_light_rotzonly_sensor.h.

Constructor & Destructor Documentation

◆ CFootBotLightRotZOnlySensor()

argos::CFootBotLightRotZOnlySensor::CFootBotLightRotZOnlySensor ( )

Definition at line 54 of file footbot_light_rotzonly_sensor.cpp.

◆ ~CFootBotLightRotZOnlySensor()

virtual argos::CFootBotLightRotZOnlySensor::~CFootBotLightRotZOnlySensor ( )
inlinevirtual

Definition at line 33 of file footbot_light_rotzonly_sensor.h.

Member Function Documentation

◆ Init()

void argos::CFootBotLightRotZOnlySensor::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 79 of file footbot_light_rotzonly_sensor.cpp.

◆ IsShowRays()

bool argos::CFootBotLightRotZOnlySensor::IsShowRays ( )
inline

Returns true if the rays must be shown in the GUI.

Returns
true if the rays must be shown in the GUI.

Definition at line 47 of file footbot_light_rotzonly_sensor.h.

◆ Reset()

void argos::CFootBotLightRotZOnlySensor::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 228 of file footbot_light_rotzonly_sensor.cpp.

◆ SetRobot()

void argos::CFootBotLightRotZOnlySensor::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 64 of file footbot_light_rotzonly_sensor.cpp.

◆ SetShowRays()

void argos::CFootBotLightRotZOnlySensor::SetShowRays ( bool  b_show_rays)
inline

Sets whether or not the rays must be shown in the GUI.

Parameters
b_show_raystrue if the rays must be shown, false otherwise

Definition at line 55 of file footbot_light_rotzonly_sensor.h.

◆ Update()

void argos::CFootBotLightRotZOnlySensor::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 107 of file footbot_light_rotzonly_sensor.cpp.

Member Data Documentation

◆ m_bAddNoise

bool argos::CFootBotLightRotZOnlySensor::m_bAddNoise
protected

Whether to add noise or not.

Definition at line 77 of file footbot_light_rotzonly_sensor.h.

◆ m_bShowRays

bool argos::CFootBotLightRotZOnlySensor::m_bShowRays
protected

Flag to show rays in the simulator.

Definition at line 71 of file footbot_light_rotzonly_sensor.h.

◆ m_cNoiseRange

CRange<Real> argos::CFootBotLightRotZOnlySensor::m_cNoiseRange
protected

Noise range.

Definition at line 80 of file footbot_light_rotzonly_sensor.h.

◆ m_cSpace

CSpace& argos::CFootBotLightRotZOnlySensor::m_cSpace
protected

Reference to the space.

Definition at line 83 of file footbot_light_rotzonly_sensor.h.

◆ m_pcControllableEntity

CControllableEntity* argos::CFootBotLightRotZOnlySensor::m_pcControllableEntity
protected

Reference to controllable entity associated to this sensor.

Definition at line 68 of file footbot_light_rotzonly_sensor.h.

◆ m_pcEmbodiedEntity

CEmbodiedEntity* argos::CFootBotLightRotZOnlySensor::m_pcEmbodiedEntity
protected

Reference to embodied entity associated to this sensor.

Definition at line 62 of file footbot_light_rotzonly_sensor.h.

◆ m_pcLightEntity

CLightSensorEquippedEntity* argos::CFootBotLightRotZOnlySensor::m_pcLightEntity
protected

Reference to light sensor equipped entity associated to this sensor.

Definition at line 65 of file footbot_light_rotzonly_sensor.h.

◆ m_pcRNG

CRandom::CRNG* argos::CFootBotLightRotZOnlySensor::m_pcRNG
protected

Random number generator.

Definition at line 74 of file footbot_light_rotzonly_sensor.h.