Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TargetProb.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 __TARGET_PROB_H__
45 #define __TARGET_PROB_H__
46 
47 #include "CoreConfig.h"
48 #include "Target.h"
49 #include "TargetFactory.h"
50 #include "fsmCommon.h"
51 #include <list>
52 
53 namespace Menge {
54 
55  namespace BFSM {
56 
57  // forward declarations
58  class State;
59  class ProbTargetFactory;
60 
62 
73  class MENGE_API ProbTarget : public TransitionTarget {
74  public:
78  ProbTarget();
79 
85  ProbTarget( const ProbTarget & tgt );
86 
98  virtual State * nextState( Agents::BaseAgent * agent );
99 
109  virtual bool connectStates( std::map< std::string, State * > & stateMap );
110 
119  virtual TransitionTarget * copy();
120 
121  friend class ProbTargetFactory;
122  protected:
127 
134 
138  std::list< std::pair< float, std::string > > _targetNames;
139 
144  std::map< State *, float > _targets;
145  };
146 
148 
152  class MENGE_API ProbTargetFactory : public TargetFactory {
153  public:
162  virtual const char * name() const { return "prob"; }
163 
171  virtual const char * description() const {
172  return "The probabalistic transition target. This allows a state to"\
173  " transition to a randomly selected member of a set of states. "\
174  "The state selected is based on weighted probabilities.";
175  }
176 
177  protected:
188  virtual TransitionTarget * instance() const { return new ProbTarget(); }
189 
208  virtual bool setFromXML( TransitionTarget * target, TiXmlElement * node, const std::string & behaveFldr ) const;
209  };
210 
211  } // namespace BFSM
212 } // namespace Menge
213 #endif // __TARGET_PROB_H__
The base class for transition targets.
Definition: Target.h:77
The basic state of the behavior finite state machine.
Definition: State.h:123
std::map< State *, float > _targets
The set of target states and their corresponding relative weights.
Definition: TargetProb.h:144
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.
float _totalWeight
The total weight of all the target states.
Definition: TargetProb.h:133
The factory for creating the ProbTarget.
Definition: TargetProb.h:152
The basis for determing what an active transition leads to.
virtual const char * description() const
A description of the action.
Definition: TargetProb.h:171
virtual const char * name() const
The name of the action.
Definition: TargetProb.h:162
std::list< std::pair< float, std::string > > _targetNames
The set of target state names and their relative weights.
Definition: TargetProb.h:138
UniformFloatGenerator _randNum
The random number generator for selecting the next state.
Definition: TargetProb.h:126
The namespace contains the Behavior Finite State Machine (BFSM) definition.
A class for parsing the xml description of a TransitionTarget and instantiating particular instances...
Definition: TargetFactory.h:61
Collection of convenient pre-compiler information for fsm definitions.
virtual TransitionTarget * instance() const
Create an instance of this class's condition.
Definition: TargetProb.h:188
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
A FloatGenerator which returns a uniformly distributed value within a defined range.
Definition: RandGenerator.h:372
The factory for parsing xml data for TransitionTarget and instantiating the appropriate class...
The definition of the probabalistic target.
Definition: TargetProb.h:73