ARGoS
3
A parallel, multi-engine simulator for swarm robotics
|
Go to the documentation of this file.
7 #include <argos3/core/simulator/simulator.h>
8 #include <argos3/core/simulator/entity/composable_entity.h>
9 #include <argos3/core/simulator/entity/embodied_entity.h>
10 #include <argos3/core/simulator/entity/floor_entity.h>
11 #include <argos3/plugins/simulator/entities/ground_sensor_equipped_entity.h>
20 static CRange<Real> UNIT(0.0f, 1.0f);
26 m_pcEmbodiedEntity(NULL),
27 m_pcFloorEntity(NULL),
28 m_pcGroundSensorEntity(NULL),
31 m_cSpace(
CSimulator::GetInstance().GetSpace()) {}
50 Real fNoiseLevel = 0.0f;
52 if(fNoiseLevel < 0.0f) {
55 else if(fNoiseLevel > 0.0f) {
89 cSensorPos += cCenterPos;
124 "ground",
"rot_z_only",
125 "Carlo Pinciroli [ilpincy@gmail.com]",
127 "A generic ground sensor (optimized for 2D).",
128 "This sensor accesses a set of ground sensors. The sensors all return a value\n"
129 "between 0 and 1, where 0 means black and 1 means white. Depending on the type\n"
130 "of ground sensor, readings can either take 0 or 1 as value (bw sensors) or a\n"
131 "value in between (grayscale sensors). In controllers, you must include the\n"
132 "ci_ground_sensor.h header.\n\n"
133 "REQUIRED XML CONFIGURATION\n\n"
136 " <my_controller ...>\n"
140 " <ground implementation=\"rot_z_only\" />\n"
144 " </my_controller>\n"
146 " </controllers>\n\n"
147 "OPTIONAL XML CONFIGURATION\n\n"
148 "It is possible to add uniform noise to the sensors, thus matching the\n"
149 "characteristics of a real robot better. This can be done with the attribute\n"
150 "\"noise_level\", whose allowed range is in [-1,1] and is added to the calculated\n"
151 "reading. The final sensor reading is always normalized in the [0-1] range.\n\n"
154 " <my_controller ...>\n"
158 " <ground implementation=\"rot_z_only\"\n"
159 " noise_level=\"0.1\" />\n"
163 " </my_controller>\n"
165 " </controllers>\n\n"
166 "OPTIONAL XML CONFIGURATION\n\n"
CQuaternion Orientation
The orientation of the anchor wrt the global coordinate system.
CRadians Uniform(const CRange< CRadians > &c_range)
Returns a random value from a uniform distribution.
Real ToGrayScale() const
Returns the color in grayscale.
CEmbodiedEntity * m_pcEmbodiedEntity
Reference to embodied entity associated to this sensor.
virtual void Reset()
Resets the sensor to the state it had just after Init().
The namespace containing all the ARGoS related code.
virtual void Init(TConfigurationNode &t_tree)
Initializes the sensor from the XML configuration tree.
It defines the basic type CRadians, used to store an angle value in radians.
Basic class for an entity that contains other entities.
The exception that wraps all errors in ARGoS.
CEntity & GetComponent(const std::string &str_component)
Returns the component with the passed string label.
size_t GetNumSensors() const
CColor GetColorAtPoint(Real f_x, Real f_y)
Returns the color at the given point.
This entity is a link to a body in the physics engine.
bool m_bAddNoise
Whether to add noise or not.
void Set(Real f_x, Real f_y)
Sets the vector contents from Cartesian coordinates.
ticpp::Element TConfigurationNode
The ARGoS configuration XML node.
Real GetY() const
Returns the y coordinate of this vector.
Real GetX() const
Returns the x coordinate of this vector.
SSensor & GetSensor(size_t un_idx)
CRandom::CRNG * m_pcRNG
Random number generator.
void ToEulerAngles(CRadians &c_z_angle, CRadians &c_y_angle, CRadians &c_x_angle) const
const std::vector< Real > & GetReadings() const
#define THROW_ARGOSEXCEPTION_NESTED(message, nested)
This macro throws an ARGoS exception with the passed message and nesting the passed exception.
virtual void SetRobot(CComposableEntity &c_entity)
Sets the entity associated to this sensor.
#define THROW_ARGOSEXCEPTION(message)
This macro throws an ARGoS exception with the passed message.
CFloorEntity * m_pcFloorEntity
Reference to floor entity.
Real GetX() const
Returns the x coordinate of this vector.
virtual void Update()
Updates the state of the entity associated to this 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")
CFloorEntity & GetFloorEntity()
Returns the floor entity.
void TruncValue(T &t_value) const
unsigned int UInt32
32-bit unsigned integer.
void GetNodeAttributeOrDefault(TConfigurationNode &t_node, const std::string &str_attribute, T &t_buffer, const T &t_default)
Returns the value of a node's attribute, or the passed default value.
void Set(const T &t_min, const T &t_max)
CRange< Real > m_cNoiseRange
Noise range.
static CRNG * CreateRNG(const std::string &str_category)
Creates a new RNG inside the given category.
Real GetY() const
Returns the y coordinate of this vector.
virtual void Init(TConfigurationNode &t_node)
Initializes the sensor from the XML configuration tree.
CVector2 & Rotate(const CRadians &c_angle)
Rotates this vector by the wanted angle.
CVector3 Position
The position of the anchor wrt the global coordinate system.
CGroundSensorEquippedEntity * m_pcGroundSensorEntity
Reference to ground sensor equipped entity associated to this sensor.
float Real
Collects all ARGoS code.
std::vector< Real > m_tReadings
CSpace & m_cSpace
Reference to the space.