Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ConstProfileSelector.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 __CONST_PROFILE_SELECTOR_H__
46 #define __CONST_PROFILE_SELECTOR_H__
47 
48 #include "mengeCommon.h"
51 
52 namespace Menge {
53 
54  namespace Agents {
59  class MENGE_API ConstProfileSelector : public ProfileSelector {
60  public:
65 
71  virtual AgentInitializer * getProfile() const { return _init; }
72 
83  virtual bool cacheProfiles( HASH_MAP< std::string, AgentInitializer * > profiles );
84 
90  void setName( const std::string & name ) { _profileName = name; }
91 
92  protected:
96  std::string _profileName;
97 
102  };
103 
105 
110  public:
115 
124  virtual const char * name() const { return "const"; }
125 
133  virtual const char * description() const {
134  return "Profile selector which assigns the same profile to all agents.";
135  };
136 
137  protected:
148  ProfileSelector * instance() const { return new ConstProfileSelector(); }
149 
168  virtual bool setFromXML( ProfileSelector * pSel, TiXmlElement * node, const std::string & specFldr ) const;
169 
173  size_t _nameID;
174 
175 
176  };
177 
178  } // namespace Agents
179 } // namespace Menge
180 #endif // __CONST_PROFILE_SELECTOR_H__
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
size_t _nameID
The identifier for the "name" string parameter.
Definition: ConstProfileSelector.h:173
void setName(const std::string &name)
Sets the name of the profile.
Definition: ConstProfileSelector.h:90
std::string _profileName
The name of the profile to use.
Definition: ConstProfileSelector.h:96
virtual const char * description() const
A description of the profile selector.
Definition: ConstProfileSelector.h:133
Class which determines the agent properties for each new agent.
Definition: AgentInitializer.h:75
virtual AgentInitializer * getProfile() const
Select an agent profile based on internal mechanisms.
Definition: ConstProfileSelector.h:71
ProfileSelector * instance() const
Create an instance of this class's profile selector implementation.
Definition: ConstProfileSelector.h:148
The factory for the ConstProfileSelector.
Definition: ConstProfileSelector.h:109
A class for parsing the xml description of an agent profile selector elements and instantiating parti...
Definition: ProfileSelectorFactory.h:59
The base class for agent profile assignment strategies.
Definition: ProfileSelector.h:100
virtual const char * name() const
The name of the profile selector type.
Definition: ConstProfileSelector.h:124
A profile selector that stores a single agent initializer and assigns this profile to all agents...
Definition: ConstProfileSelector.h:59
The namespace that contains the basic simulation mechanisms.
AgentInitializer * _init
The initializer belonging to the named profile.
Definition: ConstProfileSelector.h:101
The factory for parsing xml data and instantiating profile selector implementations.
The definition of the agent profile selector element. This is the mechanism which associates an agent...