Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSelectorSet.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_SET_H__
46 #define __GOAL_SELECTOR_SET_H__
47 
48 #include "CoreConfig.h"
49 #include "fsmCommon.h"
52 #include "GoalSet.h"
53 
54 namespace Menge {
55 
56  namespace BFSM {
62  class MENGE_API SetGoalSelector : public GoalSelector {
63  public:
68 
77  void setGoalSet( std::map< size_t, GoalSet * > & goalSets );
78 
84  void setGoalSetID( size_t id ) { _goalSetID = id; }
85 
86  protected:
96  virtual void lockResources() { _goalSet->lockRead(); }
97 
104  virtual void releaseResources() { _goalSet->releaseRead(); }
105 
112  union {
113  size_t _goalSetID;
115  };
116  };
117 
121  class MENGE_API SetGoalSelectorFactory : public GoalSelectorFactory {
122  public:
127 
128  protected:
141  virtual bool setFromXML( GoalSelector * selector, TiXmlElement * node, const std::string & behaveFldr ) const;
142 
146  size_t _goalSetID;
147  };
148  } // namespace BFSM
149 } // namespace Menge
150 
151 #endif // __GOAL_SELECTOR_SET_H__
Defines a set of goals.
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
virtual void releaseResources()
Allows the goal selector to release previously locked resources.
Definition: GoalSelectorSet.h:104
Sets up the proper compiler directives for platform and dll export/import.
size_t _goalSetID
The identifier for the "goal_set" size_t attribute.
Definition: GoalSelectorSet.h:146
A set of goals. Maps integer identifiers to instances of goals.
Definition: GoalSet.h:63
This is a base class – not to be instantiated. It provides the functional basis for GoalSelectors wh...
Definition: GoalSelectorSet.h:62
The namespace contains the Behavior Finite State Machine (BFSM) definition.
size_t _goalSetID
The identifier for the goal set.
Definition: GoalSelectorSet.h:113
Collection of convenient pre-compiler information for fsm definitions.
void setGoalSetID(size_t id)
Sets the goal set identifier.
Definition: GoalSelectorSet.h:84
GoalSet * _goalSet
The pointer to the goal set.
Definition: GoalSelectorSet.h:114
The base, abstract class for selecting per-agent goals.
Definition: GoalSelector.h:113
Defines the mechanism for selecting a goal for an agent.
virtual void lockResources()
Allows the goal selector to lock any resources it requires.
Definition: GoalSelectorSet.h:96
The factory for parsing xml data and instantiating goals.
A class for parsing the xml description of a goal selector and instantiating particular instances...
Definition: GoalSelectorFactory.h:63
Factory for the SetGoalSelector.
Definition: GoalSelectorSet.h:121