Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSelectorOffset.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 __GOAL_SELECTOR_OFFSET_H__
45 #define __GOAL_SELECTOR_OFFSET_H__
46 
47 #include "CoreConfig.h"
48 #include "fsmCommon.h"
51 
52 namespace Menge {
53 
54  namespace BFSM {
60  class MENGE_API OffsetGoalSelector : public GoalSelector {
61  public:
66 
67  protected:
72 
73  public:
81  virtual Goal * getGoal( const Agents::BaseAgent * agent ) const;
82 
91  void setDistribution( Vec2DGenerator * gen ) { _2DVel = gen; }
92 
93  protected:
97  mutable Vec2DGenerator * _2DVel;
98  };
99 
103  class MENGE_API OffsetGoalSelectorFactory : public GoalSelectorFactory {
104  public:
109 
118  virtual const char * name() const { return "offset"; }
119 
127  virtual const char * description() const {
128  return "A goal selector. The goal an agent gets is the agent's " \
129  "position offset by some user-specified 2D distribution.";
130  };
131 
132  protected:
138  GoalSelector * instance() const { return new OffsetGoalSelector(); }
139 
152  virtual bool setFromXML( GoalSelector * selector, TiXmlElement * node, const std::string & behaveFldr ) const;
153 
157  size_t _offsetID;
158  };
159  } // namespace BFSM
160 } // namespace Menge
161 
162 #endif // __GOAL_SELECTOR_OFFSET_H__
virtual const char * name() const
The name of the goal selector type.
Definition: GoalSelectorOffset.h:118
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Sets up the proper compiler directives for platform and dll export/import.
The base, abstract class defining goals.
Definition: Goal.h:110
Generic abstract class which generates a 2D vector float values.
Definition: RandGenerator.h:706
void setDistribution(Vec2DGenerator *gen)
Set the 2D number distribution for the goal selector.
Definition: GoalSelectorOffset.h:91
Vec2DGenerator * _2DVel
A vector distribution for the offset value.
Definition: GoalSelectorOffset.h:97
size_t _offsetID
The identifier for the 2D vector generator attribute.
Definition: GoalSelectorOffset.h:157
GoalSelector * instance() const
Create an instance of this class's goal selector.
Definition: GoalSelectorOffset.h:138
virtual const char * description() const
A description of the goal selector.
Definition: GoalSelectorOffset.h:127
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
The base, abstract class for selecting per-agent goals.
Definition: GoalSelector.h:113
Defines the mechanism for selecting a goal for an agent.
The offset goal selector makes a goal by applying an offset value to the agent's position at assignme...
Definition: GoalSelectorOffset.h:60
The factory for parsing xml data and instantiating goals.
Factory for the OffsetGoalSelector.
Definition: GoalSelectorOffset.h:103
A class for parsing the xml description of a goal selector and instantiating particular instances...
Definition: GoalSelectorFactory.h:63