VR-Forces 4.1 Class Documentation
vrfObjPlanAdministrator.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2007 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 /*******************************************************************************
6 ** $RCSfile: vrfObjPlanAdministrator.h,v $ $Revision: 1.4 $ $State: Exp $
7 *******************************************************************************/
8 
11 
12 #ifndef DtVrfObjPlanAdministrator_H_
13 #define DtVrfObjPlanAdministrator_H_
14 
15 class DtSimMessage;
16 class DtVrfObject;
17 class DtVrfObjectManager;
18 class DtString;
19 
20 #include <map>
21 
23 enum PlanFileVersion
24 {
25  PF_VERS_0_1,
26  PF_VERS_1_0,
27  PF_VERS_2_0
28 };
29 
41 
42 #include "vrfobjcore/vrfobjcoreDefines.h"
43 
44 class DtlObjPtr;
45 
46 class DT_DLL_vrfobjcore DtVrfObjectPlanAdministrator
47 {
48 public:
49 
50  typedef std::map<DtString, char*> CachedPlanMap;
51 
52 public:
53 
55  DtVrfObjectPlanAdministrator(DtVrfObjectManager* vrfObjectManager);
56 
59  virtual ~DtVrfObjectPlanAdministrator();
60 
63  virtual void cachePlan(const DtString& sObjName, DtlObjPtr planBlock);
64 
66  virtual void clearCachedPlans();
67 
69  virtual bool init();
70 
74  virtual const char* lookupCachedPlan(const DtString& sObjName);
75 
78  virtual bool readPlanFile(const DtString& filename);
79 
81  virtual void writePlanFile(const DtString& filename) const;
82 
86  virtual void enablePlanExecutionState();
87  virtual void disablePlanExecutionState();
89 
91  virtual bool planExecutionEnabled();
92 
94  static void setPlanCallback(DtSimMessage* msg, void* usr);
96  virtual void processSetPlan(DtSimMessage* msg);
97 
99  static void setMultiplePlanCallback(DtSimMessage* msg, void* usr);
101  virtual void processSetMultiplePlan(DtSimMessage* msg);
102 
104  static void requestPlanCallback(DtSimMessage* msg, void* usr);
106  virtual void processRequestPlan(DtSimMessage* msg);
107 
109  static void requestMultiPlanCallback(DtSimMessage* msg, void* usr);
114  virtual void processRequestMultiPlan(DtSimMessage* msg);
115 
117  static void abandonPlanCallback(DtSimMessage* msg, void* usr);
119  virtual void processAbandonPlan(DtSimMessage* msg);
120 
122  static void restartPlanCallback(DtSimMessage* msg, void* usr);
124  virtual void processRestartPlan(DtSimMessage* msg);
125 
126 protected:
127 
129  DtVrfObjectPlanAdministrator();
130 
132  DtVrfObjectPlanAdministrator(const DtVrfObjectPlanAdministrator& orig);
133 
135  DtVrfObjectPlanAdministrator& operator=(
136  const DtVrfObjectPlanAdministrator& orig);
137 
138 protected:
139  DtVrfObjectManager* myVrfObjectManager;
140 
146  CachedPlanMap myCachedPlans;
147 
148  bool myExecuting;
149 
151  static PlanFileVersion planFileCurrentVersion;
152 
153 };
154 
155 #endif
156 
Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)