vrfObjectPlanAdministrator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2015 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

class DtSimMessage;
class DtVrfObject;
class DtVrfObjectManager;
class DtString;

#include <map>

enum PlanFileVersion
{
   PF_VERS_0_1,            
   PF_VERS_1_0,             
   PF_VERS_2_0             
};


#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfutil/rwUUID.h"
#include <set>

class DtlObjPtr;
class DtlInputStream;

class DT_DLL_vrfobjcore DtVrfObjectPlanAdministrator 
{
public:

   typedef std::map<DtUUID, char*> CachedPlanMap;

public:

   DtVrfObjectPlanAdministrator(DtVrfObjectManager* vrfObjectManager);

   virtual ~DtVrfObjectPlanAdministrator();

   virtual void cachePlan(const DtUUID& sObjName, DtlObjPtr planBlock);

   virtual void clearCachedPlans();

   virtual bool init();

   virtual const char* lookupCachedPlan(const DtUUID& sObjName);

   virtual bool readPlanFile(const DtString& filename, DtlObjPtr* retArgs = 0);
   virtual bool readPlanFileFromZipFile(const DtString& scenarioZipFile, const DtString& filename, DtlObjPtr* retArgs = 0);
   virtual bool readPlanFile(const std::string& buffer, DtlObjPtr* retArgs = 0);

   virtual bool readPlanFile(DtlObjPtr& args);

   virtual void writePlanFile(const DtString& filename) const;
   virtual void writePlanFile(std::string& planFile) const;

   virtual void enablePlanExecutionState();
   virtual void disablePlanExecutionState();

   virtual void ignoreThisUUIDOnPlanRead(const DtUUID&);
   virtual void clearIgnoreUUIDsOnPleanRead();
   const std::set<DtUUID>& ignoreUUIDsOnPlanRead() const
   {
      return myIgnoreUUIDsOnPlanRead;
   }

   virtual bool planExecutionEnabled() const;

   static void setPlanCallback(DtSimMessage* msg, void* usr);
   virtual void processSetPlan(DtSimMessage* msg);

   static void setMultiplePlanCallback(DtSimMessage* msg, void* usr);
   virtual void processSetMultiplePlan(DtSimMessage* msg);

   static void requestPlanCallback(DtSimMessage* msg, void* usr);
   virtual void processRequestPlan(DtSimMessage* msg);

   static void requestMultiPlanCallback(DtSimMessage* msg, void* usr);
   virtual void processRequestMultiPlan(DtSimMessage* msg);

   static void abandonPlanCallback(DtSimMessage* msg, void* usr);
   virtual void processAbandonPlan(DtSimMessage* msg);

   static void restartPlanCallback(DtSimMessage* msg, void* usr);
   virtual void processRestartPlan(DtSimMessage* msg);

protected:
   virtual bool processPlanStream(DtlInputStream*, DtlObjPtr* retArgs = 0);

protected:

   DtVrfObjectPlanAdministrator();

   DtVrfObjectPlanAdministrator(const DtVrfObjectPlanAdministrator& orig);

   DtVrfObjectPlanAdministrator& operator=(
      const DtVrfObjectPlanAdministrator& orig);

protected:
   DtVrfObjectManager* myVrfObjectManager;

   CachedPlanMap  myCachedPlans;
   
   bool myExecuting;
   
   static PlanFileVersion planFileCurrentVersion;

   std::set<DtUUID> myIgnoreUUIDsOnPlanRead;

};