Task responsible for updating agent data for maintaining a formation.
More...
#include <FormationsTask.h>
Task responsible for updating agent data for maintaining a formation.
Constructor.
- Parameters
-
form | The formation to be maintained in the task. |
void Formations::FormationsTask::doWork |
( |
const BFSM::FSM * |
fsm | ) |
|
throw | ( | BFSM::TaskException |
| ) | | |
|
virtual |
The work performed by the task.
- Parameters
-
fsm | The finite state machine for the task to operate on. |
- Exceptions
-
A | TaskException if there was some non-fatal error in execution. It should be logged. |
A | TaskFatalException if there is a fatal error that should arrest execution of the simulation. |
Get the formation represented in this task.
- Returns
- The FormationPtr object containing the formation resource
bool Formations::FormationsTask::isEquivalent |
( |
const BFSM::Task * |
task | ) |
const |
|
virtual |
Reports if this task is "equivalent" to the given task. This makes it possible for a task to be redundantly added to the fsm without fear of duplication as the equivalent duplicates will be culled.
- Parameters
-
task | The task to test against this one. |
- Returns
- A boolean reporting if the two tasks are equivalent (true) or unique (false).
std::string Formations::FormationsTask::toString |
( |
| ) |
const |
|
virtual |
String representation of the task.
- Returns
- A string containing task information.
The documentation for this class was generated from the following files:
- src/Plugins/Formations/FormationsTask.h
- src/Plugins/Formations/FormationsTask.cpp