Formations::FormationsTask Class Reference

Task responsible for updating agent data for maintaining a formation. More...

#include <FormationsTask.h>

Inheritance diagram for Formations::FormationsTask:

Public Member Functions
	FormationsTask (Formations::FormationPtr &form)
	Constructor. More...
virtual void	doWork (const BFSM::FSM *fsm) throw ( BFSM::TaskException )
	The work performed by the task. More...
virtual std::string	toString () const
	String representation of the task. More...
virtual bool	isEquivalent (const BFSM::Task *task) const
	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. More...
const Formations::FormationPtr	getFormation () const
	Get the formation represented in this task. More...

Protected Attributes
Formations::FormationPtr	_formation
	The underlying formation data.

Detailed Description

Task responsible for updating agent data for maintaining a formation.

Constructor & Destructor Documentation

Formations::FormationsTask::FormationsTask

(

Formations::FormationPtr &

form

)

Constructor.

Parameters

form	The formation to be maintained in the task.

Member Function Documentation

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.

const Formations::FormationPtr Formations::FormationsTask::getFormation ( ) const

inline

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