Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
AircraftAction.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 __Aircraft_ACTION_H__
45 #define __Aircraft_ACTION_H__
46 
47 #include "AircraftConfig.h"
48 #include "Actions/Action.h"
49 #include "Actions/ActionFactory.h"
50 #include "SimpleLock.h"
51 #include "FSMEnumeration.h"
52 #include <map>
53 
54 using namespace Menge;
55 
56 //forward declaration
57 class TiXmlElement;
58 
64 namespace Aircraft {
65  // forward declaration
66  class SetPropertyXActFactory;
67 
72  class EXPORT_API PropertyXAction : public BFSM::Action {
73  public:
78 
82  ~PropertyXAction();
83 
90  void onEnter( Agents::BaseAgent * agent );
91 
92  friend class PropertyXActFactory;
93 
94  protected:
95 
101  void leaveAction( Agents::BaseAgent * agent );
102 
103  protected:
108  float _xOrigin;
109 
114 
120  float _scale;
121 
125  BFSM::PropertyOperand _property;
126 
131  std::map< size_t, float > _originalMap;
132 
137  };
138 
142  class EXPORT_API PropertyXActFactory : public BFSM::ActionFactory {
143  public:
152  virtual const char * name() const { return "set_xproperty"; }
153 
161  virtual const char * description() const {
162  return "Sets an agent property's value from a simple linear equation dependent on the agent's x-position.";
163  };
164 
165  protected:
176  BFSM::Action * instance() const { return new PropertyXAction(); }
177 
196  virtual bool setFromXML( BFSM::Action * action, TiXmlElement * node, const std::string & behaveFldr ) const;
197  };
198 
199 
200 
201 } // namespace Aircraft
202 
203 #endif // __Aircraft_ACTION_H__
BFSM::Action * instance() const
Create an instance of this class's action.
Definition: AircraftAction.h:176
The namespace containing Menge elements required for simulating aircraft loading and unloading...
Definition: AircraftAction.cpp:47
float _scale
The rate of change to the property for each unit displacement along the x-axis. (Essentially, this is the slope of the line.)
Definition: AircraftAction.h:120
SimpleLock _lock
Lock to protect _originalMap.
Definition: AircraftAction.h:136
virtual const char * name() const
The name of the action.
Definition: AircraftAction.h:152
Configures the shared library aspect of the includes.
virtual const char * description() const
A description of the action.
Definition: AircraftAction.h:161
float _xOrigin
The x-position at which the value is set to _originValue;.
Definition: AircraftAction.h:108
Factory for instantiating PropertyXAction instances.
Definition: AircraftAction.h:142
An action that sets agent properties based on the agent's position along the x-axis.
Definition: AircraftAction.h:72
float _originValue
The value for the property at _xOrigin;.
Definition: AircraftAction.h:113
std::map< size_t, float > _originalMap
A mapping from agent id to the agent's property value before the action was applied.
Definition: AircraftAction.h:131
BFSM::PropertyOperand _property
The property to operate on.
Definition: AircraftAction.h:125