Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSelectorShared.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_SHARED_H__
45 #define __GOAL_SELECTOR_SHARED_H__
46 
47 #include "fsmCommon.h"
50 
51 namespace Menge {
52 
53  // forward declarations
54  namespace Agents {
55  class SimulatorInterface;
56  }
57 
58  namespace BFSM {
59  // forward declarations
60  class SharedGoalSelectorFactory;
61  class FSM;
62  class FSMDescrip;
63  FSM * buildFSM( FSMDescrip & fsmDescrip, Agents::SimulatorInterface * sim, bool VERBOSE );
64 
72  public:
77 
84  virtual Goal * getGoal( const Agents::BaseAgent * agent ) const;
85 
86  friend class SharedGoalSelectorFactory;
87  friend FSM * buildFSM( FSMDescrip & fsmDescrip, Agents::SimulatorInterface * sim, bool VERBOSE );
88  protected:
93  std::string _stateName;
94 
99  int _lineNo;
100  };
101 
106  public:
115  virtual const char * name() const { return "shared"; }
116 
124  virtual const char * description() const {
125  return "A goal selector stub. Used to realize the \"shared\" " \
126  "goal selector semantics.";
127  };
128 
129  protected:
135  GoalSelector * instance() const { return new SharedGoalSelector(); }
136 
149  virtual bool setFromXML( GoalSelector * selector, TiXmlElement * node, const std::string & behaveFldr ) const;
150  };
151 
152  } // namespace BFSM
153 } // namespace Menge
154 
155 #endif // __GOAL_SELECTOR_SHARED_H__
std::string _stateName
The name of the state which will provide the actual goal selector instance.
Definition: GoalSelectorShared.h:93
The full description of the behavioral finite state machine.
Definition: FSMDescrip.h:84
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
GoalSelector * instance() const
Create an instance of this class's goal selector.
Definition: GoalSelectorShared.h:135
The base, abstract class defining goals.
Definition: Goal.h:110
The basic simulator interface required by the fsm.
Definition: SimulatorInterface.h:66
SharedGoalSelector()
Default constructor.
Definition: GoalSelectorShared.cpp:51
Templated class for the behavior finite state machine.
Definition: FSM.h:126
virtual bool setFromXML(GoalSelector *selector, TiXmlElement *node, const std::string &behaveFldr) const
Given a pointer to a GoalSelector instance, sets the appropriate fields from the provided XML node...
Definition: GoalSelectorShared.cpp:65
virtual const char * name() const
The name of the goal selector type.
Definition: GoalSelectorShared.h:115
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
int _lineNo
The line number this was defined on (for use with logger messages.
Definition: GoalSelectorShared.h:99
virtual const char * description() const
A description of the goal selector.
Definition: GoalSelectorShared.h:124
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.
The namespace that contains the basic simulation mechanisms.
The shared goal selector is a stub goal selector used strictly internally for bookkeeping. It is used to implement shared goal selectors between states. It is not intended to be sub-classed..
Definition: GoalSelectorShared.h:71
The factory for parsing xml data and instantiating goals.
virtual Goal * getGoal(const Agents::BaseAgent *agent) const
Interface function for acquiring per-agent goals.
Definition: GoalSelectorShared.cpp:55
friend FSM * buildFSM(FSMDescrip &fsmDescrip, Agents::SimulatorInterface *sim, bool VERBOSE)
Templated function which builds the behavior fsm from the behavior configuration given.
Definition: buildFSM.cpp:72
Factory for the SharedGoalSelector.
Definition: GoalSelectorShared.h:105
A class for parsing the xml description of a goal selector and instantiating particular instances...
Definition: GoalSelectorFactory.h:63