Warning: include(php/utility.php): Failed to open stream: No such file or directory in /home/argos/argos3/doc/api/embedded/a00792_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/a00792_source.php on line 2
The ARGoS Website

led_medium.cpp
Go to the documentation of this file.
1 #include "led_medium.h"
2 #include <argos3/core/simulator/simulator.h>
3 #include <argos3/core/simulator/space/space.h>
4 #include <argos3/core/simulator/space/positional_indices/grid.h>
5 #include <argos3/core/utility/configuration/argos_exception.h>
6 #include <argos3/core/utility/logging/argos_log.h>
7 
8 namespace argos {
9 
10  /****************************************/
11  /****************************************/
12 
14  }
15 
16  /****************************************/
17  /****************************************/
18 
20  }
21 
22  /****************************************/
23  /****************************************/
24 
26  try {
27  CMedium::Init(t_tree);
28  /* Get the positional index method */
29  std::string strPosIndexMethod("grid");
30  GetNodeAttributeOrDefault(t_tree, "index", strPosIndexMethod, strPosIndexMethod);
31  /* Get the arena center and size */
32  CVector3 cArenaCenter;
33  CVector3 cArenaSize;
34  TConfigurationNode& tArena = GetNode(CSimulator::GetInstance().GetConfigurationRoot(), "arena");
35  GetNodeAttribute(tArena, "size", cArenaSize);
36  GetNodeAttributeOrDefault(tArena, "center", cArenaCenter, cArenaCenter);
37  /* Create the positional index for LED entities */
38  if(strPosIndexMethod == "grid") {
39  size_t punGridSize[3];
40  if(!NodeAttributeExists(t_tree, "grid_size")) {
41  punGridSize[0] = cArenaSize.GetX();
42  punGridSize[1] = cArenaSize.GetY();
43  punGridSize[2] = cArenaSize.GetZ();
44  }
45  else {
46  std::string strPosGridSize;
47  GetNodeAttribute(t_tree, "grid_size", strPosGridSize);
48  ParseValues<size_t>(strPosGridSize, 3, punGridSize, ',');
49  }
51  cArenaCenter - cArenaSize * 0.5f, cArenaCenter + cArenaSize * 0.5f,
52  punGridSize[0], punGridSize[1], punGridSize[2]);
53  m_pcLEDEntityGridUpdateOperation = new CLEDEntityGridUpdater(*pcGrid);
54  pcGrid->SetUpdateEntityOperation(m_pcLEDEntityGridUpdateOperation);
55  m_pcLEDEntityIndex = pcGrid;
56  }
57  else {
58  THROW_ARGOSEXCEPTION("Unknown method \"" << strPosIndexMethod << "\" for the positional index.");
59  }
60  }
61  catch(CARGoSException& ex) {
62  THROW_ARGOSEXCEPTION_NESTED("Error in initialization of the LED medium", ex);
63  }
64  }
65 
66  /****************************************/
67  /****************************************/
68 
70  Update();
71  }
72 
73  /****************************************/
74  /****************************************/
75 
77  m_pcLEDEntityIndex->Reset();
78  }
79 
80  /****************************************/
81  /****************************************/
82 
84  delete m_pcLEDEntityIndex;
85  if(m_pcLEDEntityGridUpdateOperation != NULL) {
86  delete m_pcLEDEntityGridUpdateOperation;
87  }
88  }
89 
90  /****************************************/
91  /****************************************/
92 
94  m_pcLEDEntityIndex->Update();
95  }
96 
97  /****************************************/
98  /****************************************/
99 
101  m_pcLEDEntityIndex->AddEntity(c_entity);
102  }
103 
104  /****************************************/
105  /****************************************/
106 
108  m_pcLEDEntityIndex->RemoveEntity(c_entity);
109  }
110 
111  /****************************************/
112  /****************************************/
113 
115  "led",
116  "Carlo Pinciroli [ilpincy@gmail.com]",
117  "1.0",
118  "Manages the LEDs.",
119  "This medium is required to manage the LED entities, thus allowing the\n"
120  "associated camera sensors to work properly. If you intend to use a camera\n"
121  "sensor that detects colored blobs, you must add this medium to the XML\n"
122  "configuration file.\n\n"
123  "REQUIRED XML CONFIGURATION\n\n"
124  "<led id=\"led\" />\n\n"
125  "OPTIONAL XML CONFIGURATION\n\n"
126  "None for the time being\n",
127  "Under development"
128  );
129 
130  /****************************************/
131  /****************************************/
132 
133 }
virtual void Reset()
Resets the resource.
Definition: led_medium.cpp:76
A 3D vector class.
Definition: vector3.h:29
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.
CLEDMedium()
Class constructor.
Definition: led_medium.cpp:13
virtual ~CLEDMedium()
Class destructor.
Definition: led_medium.cpp:19
virtual void Destroy()
Undoes whatever was done by Init().
Definition: led_medium.cpp:83
#define THROW_ARGOSEXCEPTION(message)
This macro throws an ARGoS exception with the passed message.
Real GetX() const
Returns the x coordinate of this vector.
Definition: vector3.h:93
Real GetY() const
Returns the y coordinate of this vector.
Definition: vector3.h:109
void SetUpdateEntityOperation(CEntityOperation *pc_operation)
Definition: grid_impl.h:907
TConfigurationNode & GetNode(TConfigurationNode &t_node, const std::string &str_tag)
Given a tree root node, returns the first of its child nodes with the wanted name.
ticpp::Element TConfigurationNode
The ARGoS configuration XML node.
void RemoveEntity(CLEDEntity &c_entity)
Removes the specified entity from the list of managed entities.
Definition: led_medium.cpp:107
#define THROW_ARGOSEXCEPTION_NESTED(message, nested)
This macro throws an ARGoS exception with the passed message and nesting the passed exception...
virtual void Init(TConfigurationNode &t_tree)
Initialized the medium.
Definition: medium.cpp:16
bool NodeAttributeExists(TConfigurationNode &t_node, const std::string &str_attribute)
Returns true if the specified attribute of a node exists.
virtual void Init(TConfigurationNode &t_tree)
Initialized the medium.
Definition: led_medium.cpp:25
void GetNodeAttribute(TConfigurationNode &t_node, const std::string &str_attribute, T &t_buffer)
Returns the value of a node's attribute.
virtual void PostSpaceInit()
Executes extra initialization activities after the space has been initialized.
Definition: led_medium.cpp:69
The exception that wraps all errors in ARGoS.
void AddEntity(CLEDEntity &c_entity)
Adds the specified entity to the list of managed entities.
Definition: led_medium.cpp:100
REGISTER_MEDIUM(CDirectionalLEDMedium,"directional_led","Michael Allwright [allsey87@gmail.com]","1.0","Manages directional LED entities.","This medium is required to manage the directional LED entities, so that\n""the associated camera sensors can find them. If you use a camera sensor,\n""you must add this medium the sensors XML configuration.\n\n""REQUIRED XML CONFIGURATION\n\n""<directional_led id=\"led\" />\n\n""OPTIONAL XML CONFIGURATION\n\n""None for the time being\n","Under development")
virtual void Update()
Updates the state of this medium.
Definition: led_medium.cpp:93
The namespace containing all the ARGoS related code.
Definition: ci_actuator.h:12
Real GetZ() const
Returns the z coordinate of this vector.
Definition: vector3.h:125
static CSimulator & GetInstance()
Returns the instance to the CSimulator class.
Definition: simulator.cpp:78