VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
vrfObjectPlanAdministrator.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2015 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 class DtSimMessage;
12 class DtVrfObject;
13 class DtVrfObjectManager;
14 class DtString;
15 
16 #include <map>
17 
19 enum PlanFileVersion
20 {
21  PF_VERS_0_1,
22  PF_VERS_1_0,
23  PF_VERS_2_0
24 };
25 
37 
38 #include "vrfobjcore/vrfobjcoreDefines.h"
39 #include "vrfutil/rwUUID.h"
40 
41 class DtlObjPtr;
42 class DtlInputStream;
43 
44 class DT_DLL_vrfobjcore DtVrfObjectPlanAdministrator
45 {
46 public:
47 
48  typedef std::map<DtUUID, char*> CachedPlanMap;
49 
50 public:
51 
53  DtVrfObjectPlanAdministrator(DtVrfObjectManager* vrfObjectManager);
54 
57  virtual ~DtVrfObjectPlanAdministrator();
58 
61  virtual void cachePlan(const DtUUID& sObjName, DtlObjPtr planBlock);
62 
64  virtual void clearCachedPlans();
65 
67  virtual bool init();
68 
72  virtual const char* lookupCachedPlan(const DtUUID& sObjName);
73 
77  virtual bool readPlanFile(const DtString& filename, DtlObjPtr* retArgs = 0);
78  virtual bool readPlanFileFromZipFile(const DtString& scenarioZipFile, const DtString& filename, DtlObjPtr* retArgs = 0);
79  virtual bool readPlanFile(const std::string& buffer, DtlObjPtr* retArgs = 0);
80 
81  virtual bool readPlanFile(DtlObjPtr& args);
82 
84  virtual void writePlanFile(const DtString& filename) const;
85  virtual void writePlanFile(std::string& planFile) const;
86 
90  virtual void enablePlanExecutionState();
91  virtual void disablePlanExecutionState();
93 
95  virtual bool planExecutionEnabled();
96 
98  static void setPlanCallback(DtSimMessage* msg, void* usr);
100  virtual void processSetPlan(DtSimMessage* msg);
101 
103  static void setMultiplePlanCallback(DtSimMessage* msg, void* usr);
105  virtual void processSetMultiplePlan(DtSimMessage* msg);
106 
108  static void requestPlanCallback(DtSimMessage* msg, void* usr);
110  virtual void processRequestPlan(DtSimMessage* msg);
111 
113  static void requestMultiPlanCallback(DtSimMessage* msg, void* usr);
118  virtual void processRequestMultiPlan(DtSimMessage* msg);
119 
121  static void abandonPlanCallback(DtSimMessage* msg, void* usr);
123  virtual void processAbandonPlan(DtSimMessage* msg);
124 
126  static void restartPlanCallback(DtSimMessage* msg, void* usr);
128  virtual void processRestartPlan(DtSimMessage* msg);
129 
130 protected:
131  virtual bool processPlanStream(DtlInputStream*, DtlObjPtr* retArgs = 0);
132 
133 protected:
134 
136  DtVrfObjectPlanAdministrator();
137 
139  DtVrfObjectPlanAdministrator(const DtVrfObjectPlanAdministrator& orig);
140 
142  DtVrfObjectPlanAdministrator& operator=(
143  const DtVrfObjectPlanAdministrator& orig);
144 
145 protected:
146  DtVrfObjectManager* myVrfObjectManager;
147 
153  CachedPlanMap myCachedPlans;
154 
155  bool myExecuting;
156 
158  static PlanFileVersion planFileCurrentVersion;
159 
160 };
Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)