A debug algorithm that prints detailed status information.
More...
#include <DebugAlgorithm.h>
A debug algorithm that prints detailed status information.
Definition at line 77 of file DebugAlgorithm.h.
◆ DebugAlgorithm()
Constructor.
- Parameters
-
knowledge | the context containing variables and values |
platform | the underlying platform the algorithm will use |
sensors | map of sensor names to sensor information |
self | self-referencing variables |
executions_location | location of an executions variable within the knowledge base to use for printing, after the .id identifier. |
◆ ~DebugAlgorithm()
gams::algorithms::DebugAlgorithm::~DebugAlgorithm |
( |
| ) |
|
◆ analyze()
virtual int gams::algorithms::DebugAlgorithm::analyze |
( |
void |
| ) |
|
|
virtual |
◆ execute()
virtual int gams::algorithms::DebugAlgorithm::execute |
( |
void |
| ) |
|
|
virtual |
◆ get_agents()
◆ get_algorithm_status()
Gets algorithm status variables.
◆ get_knowledge_base()
madara::knowledge::KnowledgeBase* gams::algorithms::BaseAlgorithm::get_knowledge_base |
( |
void |
| ) |
|
|
inherited |
◆ get_platform()
◆ get_self()
Gets self-defined variables.
◆ get_sensors()
Gets the available sensor information.
◆ operator=()
void gams::algorithms::DebugAlgorithm::operator= |
( |
const DebugAlgorithm & |
rhs | ) |
|
Assignment operator.
- Parameters
-
◆ plan()
virtual int gams::algorithms::DebugAlgorithm::plan |
( |
void |
| ) |
|
|
virtual |
◆ set_agents()
virtual void gams::algorithms::BaseAlgorithm::set_agents |
( |
variables::Agents * |
agents | ) |
|
|
virtualinherited |
Sets the list of agents in the swarm.
- Parameters
-
◆ set_platform()
Sets the platform.
- Parameters
-
platform | the underlying platform the algorithm will use |
◆ set_self()
virtual void gams::algorithms::BaseAlgorithm::set_self |
( |
variables::Self * |
self | ) |
|
|
virtualinherited |
Sets the map of sensor names to sensor information.
- Parameters
-
self | pointer to self-referencing variables container |
◆ set_sensors()
Sets the map of sensor names to sensor information.
- Parameters
-
sensors | map of sensor names to sensor information |
◆ agents_
the list of agents potentially participating in the algorithm
Definition at line 201 of file BaseAlgorithm.h.
◆ executions_
unsigned int gams::algorithms::BaseAlgorithm::executions_ |
|
protectedinherited |
◆ k_executions_
madara::knowledge::containers::Integer gams::algorithms::DebugAlgorithm::k_executions_ |
|
protected |
Used to keep track of algorithm executions in a way that may be referenced from other platforms or algorithms within the knowledge base(k is for KnowledgeBase).
This is different from executions_, which can only be seen by the derived classes of BaseAlgorithm.
Definition at line 134 of file DebugAlgorithm.h.
◆ knowledge_
madara::knowledge::KnowledgeBase* gams::algorithms::BaseAlgorithm::knowledge_ |
|
protectedinherited |
◆ platform_
◆ self_
◆ sensors_
◆ status_
provides access to status information for this platform
Definition at line 219 of file BaseAlgorithm.h.
The documentation for this class was generated from the following file: