Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSelectorExplicit.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 
45 #ifndef __GOAL_SELECTOR_EXCPLICIT_H__
46 #define __GOAL_SELECTOR_EXCPLICIT_H__
47 
48 #include "CoreConfig.h"
49 #include "fsmCommon.h"
52 
53 namespace Menge {
54 
55  namespace BFSM {
56  // forward declaration
57  class Goal;
58 
63  class MENGE_API ExplicitGoalSelector : public GoalSelector {
64  public:
69 
77  virtual Goal * getGoal( const Agents::BaseAgent * agent ) const;
78 
87  void setGoalSet( std::map< size_t, GoalSet * > & goalSets );
88 
94  void setGoalSetID( size_t id ) { _goalSetID = id; }
95 
101  void setGoalID( size_t id ) { _goalID = id; }
102 
103  protected:
107  size_t _goalSetID;
108 
115  union {
116  size_t _goalID;
118  };
119  };
120 
125  public:
130 
139  virtual const char * name() const { return "explicit"; }
140 
148  virtual const char * description() const {
149  return "A goal selector. The goal an agent gets is " \
150  "explicitly enumeraged, goal set and goal id.";
151  };
152 
153  protected:
159  GoalSelector * instance() const { return new ExplicitGoalSelector(); }
160 
173  virtual bool setFromXML( GoalSelector * selector, TiXmlElement * node, const std::string & behaveFldr ) const;
174 
178  size_t _goalSetID;
179 
183  size_t _goalID;
184  };
185 
186  } // namespace BFSM
187 } // namespace Menge
188 
189 #endif // __GOAL_SELECTOR_EXCPLICIT_H__
size_t _goalSetID
The identifier for the "goal_set" size_t attribute.
Definition: GoalSelectorExplicit.h:178
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.
void setGoalSetID(size_t id)
Sets the goal set identifier.
Definition: GoalSelectorExplicit.h:94
The base, abstract class defining goals.
Definition: Goal.h:110
Goal * _goal
The pointer to the goal.
Definition: GoalSelectorExplicit.h:117
size_t _goalID
The identifier for the "goal" size_t attribute.
Definition: GoalSelectorExplicit.h:183
GoalSelector * instance() const
Create an instance of this class's goal selector.
Definition: GoalSelectorExplicit.h:159
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Factory for the ExplicitGoalSelector.
Definition: GoalSelectorExplicit.h:124
Collection of convenient pre-compiler information for fsm definitions.
size_t _goalSetID
The id of the goal set to draw from.
Definition: GoalSelectorExplicit.h:107
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.
virtual const char * name() const
The name of the goal selector type.
Definition: GoalSelectorExplicit.h:139
virtual const char * description() const
A description of the goal selector.
Definition: GoalSelectorExplicit.h:148
The factory for parsing xml data and instantiating goals.
void setGoalID(size_t id)
Sets the goal identifier.
Definition: GoalSelectorExplicit.h:101
The explicit goal selector makes extracts a specific goal from a specific goal set – both explicitly...
Definition: GoalSelectorExplicit.h:63
A class for parsing the xml description of a goal selector and instantiating particular instances...
Definition: GoalSelectorFactory.h:63
size_t _goalID
The identifier for the goal.
Definition: GoalSelectorExplicit.h:116