Warning: include(php/utility.php): Failed to open stream: No such file or directory in /home/argos/argos3/doc/api/embedded/a00592_source.php on line 2

Warning: include(): Failed opening 'php/utility.php' for inclusion (include_path='.:/usr/lib64/php') in /home/argos/argos3/doc/api/embedded/a00592_source.php on line 2
The ARGoS Website

footbot_turret_encoder_default_sensor.cpp
Go to the documentation of this file.
1 
7 #include "footbot_turret_encoder_default_sensor.h"
8 #include <argos3/core/simulator/entity/composable_entity.h>
9 
10 namespace argos {
11 
12  /****************************************/
13  /****************************************/
14 
15  CFootBotTurretEncoderDefaultSensor::CFootBotTurretEncoderDefaultSensor() :
16  m_pcTurretEntity(NULL) {}
17 
18  /****************************************/
19  /****************************************/
20 
21  void CFootBotTurretEncoderDefaultSensor::SetRobot(CComposableEntity& c_entity) {
22  m_pcTurretEntity = &(c_entity.GetComponent<CFootBotTurretEntity>("turret"));
23  m_pcTurretEntity->Enable();
24  }
25 
26  /****************************************/
27  /****************************************/
28 
29  void CFootBotTurretEncoderDefaultSensor::Update() {
30  m_cRotation = m_pcTurretEntity->GetRotation();
31  }
32 
33  /****************************************/
34  /****************************************/
35 
36  void CFootBotTurretEncoderDefaultSensor::Reset() {
37  m_cRotation = CRadians::ZERO;
38  }
39 
40  /****************************************/
41  /****************************************/
42 
43  REGISTER_SENSOR(CFootBotTurretEncoderDefaultSensor,
44  "footbot_turret_encoder", "default",
45  "Carlo Pinciroli [ilpincy@gmail.com]",
46  "1.0",
47  "The foot-bot turret encoder sensor.",
48  "This sensor accesses the foot-bot turret encoder. For a complete\n"
49  "description of its usage, refer to the ci_footbot_turret_encoder_sensor\n"
50  "file.\n\n"
51  "REQUIRED XML CONFIGURATION\n\n"
52  " <controllers>\n"
53  " ...\n"
54  " <my_controller ...>\n"
55  " ...\n"
56  " <sensors>\n"
57  " ...\n"
58  " <footbot_turret_encoder implementation=\"default\" />\n"
59  " ...\n"
60  " </sensors>\n"
61  " ...\n"
62  " </my_controller>\n"
63  " ...\n"
64  " </controllers>\n\n"
65  "OPTIONAL XML CONFIGURATION\n\n"
66  "None for the time being.\n",
67  "Usable"
68  );
69 
70 }
argos::CEntity::Enable
void Enable()
Enables the entity.
Definition: entity.h:265
argos::CFootBotTurretEncoderDefaultSensor::Reset
virtual void Reset()
Resets the sensor to the state it had just after Init().
Definition: footbot_turret_encoder_default_sensor.cpp:36
argos::CComposableEntity
Basic class for an entity that contains other entities.
Definition: composable_entity.h:32
argos::CFootBotTurretEncoderDefaultSensor::Update
virtual void Update()
Updates the state of the entity associated to this sensor.
Definition: footbot_turret_encoder_default_sensor.cpp:29
argos::CRadians::ZERO
static const CRadians ZERO
Set to zero radians.
Definition: angles.h:79
argos::CFootBotTurretEncoderDefaultSensor::SetRobot
virtual void SetRobot(CComposableEntity &c_entity)
Sets the entity associated to this sensor.
Definition: footbot_turret_encoder_default_sensor.cpp:21
argos
The namespace containing all the ARGoS related code.
Definition: ci_actuator.h:12
argos::CComposableEntity::GetComponent
CEntity & GetComponent(const std::string &str_component)
Returns the component with the passed string label.
Definition: composable_entity.cpp:109
argos::REGISTER_SENSOR
REGISTER_SENSOR(CEyeBotLightRotZOnlySensor,"eyebot_light","rot_z_only","Carlo Pinciroli [ilpincy@gmail.com]","1.0","The eye-bot light sensor (optimized for 2D).","This sensor accesses a set of light sensors. The sensors all return a value\n""between 0 and 1, where 0 means nothing within range and 1 means the perceived\n""light saturates the sensor. Values between 0 and 1 depend on the distance of\n""the perceived light. Each reading R is calculated with R=(I/x)^2, where x is the\n""distance between a sensor and the light, and I is the reference intensity of the\n""perceived light. The reference intensity corresponds to the minimum distance at\n""which the light saturates a sensor. The reference intensity depends on the\n""individual light, and it is set with the \"intensity\" attribute of the light\n""entity. In case multiple lights are present in the environment, each sensor\n""reading is calculated as the sum of the individual readings due to each light.\n""In other words, light wave interference is not taken into account. In\n""controllers, you must include the ci_light_sensor.h header.\n\n""REQUIRED XML CONFIGURATION\n\n"" <controllers>\n"" ...\n"" <my_controller ...>\n"" ...\n"" <sensors>\n"" ...\n"" <eyebot_light implementation=\"rot_z_only\" />\n"" ...\n"" </sensors>\n"" ...\n"" </my_controller>\n"" ...\n"" </controllers>\n\n""OPTIONAL XML CONFIGURATION\n\n""It is possible to draw the rays shot by the light sensor in the OpenGL\n""visualization. This can be useful for sensor debugging but also to understand\n""what's wrong in your controller. In OpenGL, the rays are drawn in cyan when\n""they are not obstructed and in purple when they are. In case a ray is\n""obstructed, a black dot is drawn where the intersection occurred.\n""To turn this functionality on, add the attribute \"show_rays\" as in this\n""example:\n\n"" <controllers>\n"" ...\n"" <my_controller ...>\n"" ...\n"" <sensors>\n"" ...\n"" <eyebot_light implementation=\"rot_z_only\"\n"" show_rays=\"true\" />\n"" ...\n"" </sensors>\n"" ...\n"" </my_controller>\n"" ...\n"" </controllers>\n\n""It is possible to add uniform noise to the sensors, thus matching the\n""characteristics of a real robot better. This can be done with the attribute\n""\"noise_level\", whose allowed range is in [-1,1] and is added to the calculated\n""reading. The final sensor reading is always normalized in the [0-1] range.\n\n"" <controllers>\n"" ...\n"" <my_controller ...>\n"" ...\n"" <sensors>\n"" ...\n"" <eyebot_light implementation=\"rot_z_only\"\n"" noise_level=\"0.1\" />\n"" ...\n"" </sensors>\n"" ...\n"" </my_controller>\n"" ...\n"" </controllers>\n\n""OPTIONAL XML CONFIGURATION\n\n""None.\n","Usable")