Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Task.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 
39 #ifndef __TASK_H__
40 #define __TASK_H__
41 
47 #include "fsmCommon.h"
48 #include "Element.h"
49 #include "MengeException.h"
50 
51 #include <string>
52 
53 // forward declaration
54 class TiXmlElement;
55 
56 namespace Menge {
57 
58  namespace BFSM {
59 
60  // FORWARD DECLARATIONS
61  class FSM;
62 
68  class TaskException : public virtual MengeException {
69  public:
74 
80  TaskException( const std::string & s ): MengeException(s) {}
81 
82  };
83 
89  public:
94 
101  };
102 
110  class MENGE_API Task : public Element {
111  protected:
115  virtual ~Task(){}
116 
117  public:
129  virtual void doWork( const FSM * fsm ) throw( TaskException ) = 0;
130 
138  virtual std::string toString() const = 0;
139 
151  virtual bool isEquivalent( const Task * task ) const = 0;
152  };
153 
162  Task * parseTask( TiXmlElement * node, const std::string & behaveFldr );
163  } // namespace BFSM
164 } // namespace Menge
165 #endif // __TASK_H__
Exception thrown when the task has an error which cannot be recovered from.
Definition: Task.h:88
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
TaskFatalException(const std::string &s)
Constructor with message.
Definition: Task.h:100
TaskFatalException()
Default constructor.
Definition: Task.h:93
The base definition for exceptions in Menge.
Base class for all Menge elements.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
Base exception class for menge operations.
Definition: MengeException.h:58
Templated class for the behavior finite state machine.
Definition: FSM.h:126
Base class for fatal exceptions.
Definition: MengeException.h:99
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
Interface for basic FSM task.
Definition: Task.h:110
TaskException(const std::string &s)
Constructor with message.
Definition: Task.h:80
virtual ~Task()
Virtual destructor.
Definition: Task.h:115
Exception thrown when a task fails at doing its work. These exceptions can be logged but should not a...
Definition: Task.h:68
TaskException()
Default constructor.
Definition: Task.h:73