Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSet.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 __GOALSET_H__
45 #define __GOALSET_H__
46 
47 #include "fsmCommon.h"
48 #include "ReadersWriterLock.h"
49 #include <map>
50 
51 namespace Menge {
52 
53  namespace BFSM {
54 
55  // Forward declaration
56  class Goal;
57 
59 
63  class MENGE_API GoalSet {
64  public:
68  GoalSet();
69 
73  ~GoalSet();
74 
86  bool addGoal( size_t id, Goal * goal );
87 
100  Goal * getGoalByID( size_t id );
101 
114  Goal * getGoalByIDConcurrent( size_t id );
115 
128  Goal * getIthGoal( size_t i );
129 
142  Goal * getIthGoalConcurrent( size_t i );
143 
149  size_t size() const { return _goalIDs.size(); }
150 
156  size_t sizeConcurrent() const;
157 
163  Goal * getRandomGoal();
164 
170  Goal * getRandomWeightedGoal();
171 
175  void lockRead() { _lock.lockRead(); }
176 
180  void releaseRead() { _lock.releaseRead(); }
181 
182  friend class Goal;
183 
184  protected:
189  void setGoalFull( const Goal * goal ) const;
190 
196  void setGoalAvailable( const Goal * goal ) const;
197 
201  std::map< size_t, Goal * > _goals;
202 
206  mutable std::vector< size_t > _goalIDs;
207 
211  mutable float _totalWeight;
212 
217 
223  };
224 
225 
226  } // namespace BFSM
227 } // namespace Menge
228 
229 #endif //__GOALSET_H__
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
std::vector< size_t > _goalIDs
A vector of valid identifiers in the goal set.
Definition: GoalSet.h:206
void lockRead()
Locks the goal set for a read-only operations.
Definition: GoalSet.h:175
A set of goals. Maps integer identifiers to instances of goals.
Definition: GoalSet.h:63
The base, abstract class defining goals.
Definition: Goal.h:110
The definition of a readers-writer lock.
Definition: ReadersWriterLock.h:62
size_t size() const
Reports the number of goals in the set. Not thread safe.
Definition: GoalSet.h:149
ReadersWriterLock _lock
The lock to maintain readers-writer access to the structure which control available goals...
Definition: GoalSet.h:222
float _totalWeight
The sum of all goal weights.
Definition: GoalSet.h:211
The definition of a readers-writer lock.
UniformFloatGenerator _randVal
The random die to select random and weighted goals.
Definition: GoalSet.h:216
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
A FloatGenerator which returns a uniformly distributed value within a defined range.
Definition: RandGenerator.h:372
std::map< size_t, Goal * > _goals
The underlying mapping from user-specified goal identifier to goal.
Definition: GoalSet.h:201
void releaseRead()
Unlocks the goal set from read-only operations.
Definition: GoalSet.h:180