Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
FormationsTask.h
Go to the documentation of this file.
1 /*
2 
3 License
4 
5 Menge
6 Copyright and trademark 2012-14 University of North Carolina at Chapel Hill.
7 All rights reserved.
8 
9 Permission to use, copy, modify, and distribute this software and its documentation
10 for educational, research, and non-profit purposes, without fee, and without a
11 written agreement is hereby granted, provided that the above copyright notice,
12 this paragraph, and the following four paragraphs appear in all copies.
13 
14 This software program and documentation are copyrighted by the University of North
15 Carolina at Chapel Hill. The software program and documentation are supplied "as is,"
16 without any accompanying services from the University of North Carolina at Chapel
17 Hill or the authors. The University of North Carolina at Chapel Hill and the
18 authors do not warrant that the operation of the program will be uninterrupted
19 or error-free. The end-user understands that the program was developed for research
20 purposes and is advised not to rely exclusively on the program for any reason.
21 
22 IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS
23 BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
24 DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
25 DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE
26 AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY
29 DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY
31 OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
32 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS
33 TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
34 
35 Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu
36 
37 */
38 
44 #ifndef __FORMATIONS_TASK_H__
45 #define __FORMATIONS_TASK_H__
46 
47 #include "Tasks/Task.h"
48 #include "fsmCommon.h"
49 #include <string>
50 #include "Tasks/TaskFactory.h"
51 #include "tinyxml.h"
52 #include "FreeFormation.h"
53 #include "FormationsModifier.h"
54 
55 using namespace Menge;
56 
57 namespace Formations {
61  class FormationsTask : public BFSM::Task {
62  public:
70 
80  virtual void doWork( const BFSM::FSM * fsm ) throw( BFSM::TaskException );
81 
87  virtual std::string toString() const;
88 
99  virtual bool isEquivalent( const BFSM::Task * task ) const;
100 
106  const Formations::FormationPtr getFormation() const { return _formation;}
107 
108  protected:
113 
114  };
115 
116 
117 
118 }
119 #endif // __DENSITY_GRID_TASK_H__
definition of a VelocityModifier to enforce formation behavior
The name space for the Formation Model.
Definition: FormationsModifier.cpp:45
Task responsible for updating agent data for maintaining a formation.
Definition: FormationsTask.h:61
Formations::FormationPtr _formation
The underlying formation data.
Definition: FormationsTask.h:112
const Formations::FormationPtr getFormation() const
Get the formation represented in this task.
Definition: FormationsTask.h:106
Implementatin of freestyle formations.