include/vrfobjcore/vrfObjPlanAdministrator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2007 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: vrfObjPlanAdministrator.h,v $ $Revision: 1.4 $ $State: Exp $
*******************************************************************************/


#ifndef DtVrfObjPlanAdministrator_H_
#define DtVrfObjPlanAdministrator_H_

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"

class DtlObjPtr;

class DT_DLL_vrfobjcore DtVrfObjectPlanAdministrator 
{
public:

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

public:

   DtVrfObjectPlanAdministrator(DtVrfObjectManager* vrfObjectManager);

   virtual ~DtVrfObjectPlanAdministrator();

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

   virtual void clearCachedPlans();

   virtual bool init();

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

   virtual bool readPlanFile(const DtString& filename);

   virtual void writePlanFile(const DtString& filename) const;

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

   virtual bool planExecutionEnabled();

   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:

   DtVrfObjectPlanAdministrator();

   DtVrfObjectPlanAdministrator(const DtVrfObjectPlanAdministrator& orig);

   DtVrfObjectPlanAdministrator& operator=(
      const DtVrfObjectPlanAdministrator& orig);

protected:
   DtVrfObjectManager* myVrfObjectManager;

   CachedPlanMap  myCachedPlans;
   
   bool myExecuting;
   
   static PlanFileVersion planFileCurrentVersion;

};

#endif