Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSelector.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_H__
45 #define __GOAL_SELECTOR_H__
46 
47 #include "CoreConfig.h"
48 #include "fsmCommon.h"
49 #include "Element.h"
50 #include "ReadersWriterLock.h"
51 #include "MengeException.h"
52 #include <map>
53 
54 // forward declaration
55 class TiXmlElement;
56 
57 namespace Menge {
58 
59  // forward declaration
60  namespace Agents {
61  class BaseAgent;
62  }
63 
64  namespace BFSM {
65 
66  // forward declaration
67  class GoalSet;
68  class Goal;
69 
73  class MENGE_API GoalSelectorException : public virtual MengeException {
74  public:
79 
85  GoalSelectorException( const std::string & s ): MengeException(s) {}
86 
87  };
88 
94  public:
99 
106  };
107 
109 
113  class MENGE_API GoalSelector : public Element {
114  public:
118  GoalSelector():Element(), _persistent(false), _assignedGoals() {}
119 
120  protected:
124  virtual ~GoalSelector(){}
125 
126  public:
139  Goal * assignGoal( const Agents::BaseAgent * agent );
140 
153  void freeGoal( const Agents::BaseAgent * agent, Goal * goal );
154 
162  virtual Goal * getGoal( const Agents::BaseAgent * agent ) const = 0;
163 
172  virtual void setGoalSet( std::map< size_t, GoalSet * > & goalSets ){}
173 
179  inline void setPersistence( bool state ) { _persistent = state; }
180 
186  inline bool getPersistence() const { return _persistent; }
187 
188  protected:
198  virtual void lockResources() {}
199 
206  virtual void releaseResources() {}
207 
216 
224  HASH_MAP< size_t, Goal * > _assignedGoals;
225 
231  };
232 
241  GoalSelector * parseGoalSelector( TiXmlElement * node, const std::string & behaveFldr );
242 
243  } // namespace BFSM
244 } // namespace Menge
245 #endif //__GOAL_SELECTOR_H__
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Exception class for goal generation.
Definition: GoalSelector.h:73
Sets up the proper compiler directives for platform and dll export/import.
Exception thrown when the goal selector has an error which cannot be recovered from.
Definition: GoalSelector.h:93
virtual ~GoalSelector()
Default virtual destructor.
Definition: GoalSelector.h:124
The base, abstract class defining goals.
Definition: Goal.h:110
bool _persistent
Determines if the GoalSelector maintains persistent goals.
Definition: GoalSelector.h:215
The definition of a readers-writer lock.
Definition: ReadersWriterLock.h:62
The base definition for exceptions in Menge.
virtual void setGoalSet(std::map< size_t, GoalSet * > &goalSets)
Gives the instance the opportunity to set the goal set.
Definition: GoalSelector.h:172
Base class for all Menge elements.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
ReadersWriterLock _lock
The lock to maintain readers-writer access to the _assignedGoals.
Definition: GoalSelector.h:230
Base exception class for menge operations.
Definition: MengeException.h:58
void setPersistence(bool state)
Sets the persistence of the goal.
Definition: GoalSelector.h:179
GoalSelectorFatalException()
Default constructor.
Definition: GoalSelector.h:98
bool getPersistence() const
Reports the persistence of the goal.
Definition: GoalSelector.h:186
The definition of a readers-writer lock.
Base class for fatal exceptions.
Definition: MengeException.h:99
GoalSelectorFatalException(const std::string &s)
Constructor with message.
Definition: GoalSelector.h:105
The namespace contains the Behavior Finite State Machine (BFSM) definition.
GoalSelectorException(const std::string &s)
Constructor with message.
Definition: GoalSelector.h:85
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
GoalSelector()
Default constructor.
Definition: GoalSelector.h:118
virtual void releaseResources()
Allows the goal selector to release previously locked resources.
Definition: GoalSelector.h:206
The namespace that contains the basic simulation mechanisms.
virtual void lockResources()
Allows the goal selector to lock any resources it requires.
Definition: GoalSelector.h:198
HASH_MAP< size_t, Goal * > _assignedGoals
A mapping from agent id to assigned goals. This will only contain meaningful values in one of two cas...
Definition: GoalSelector.h:224
GoalSelectorException()
Default constructor.
Definition: GoalSelector.h:78