vrfObjectPlanManager.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/vrfObjectPlanManagerFactory.h"
#include "vrfobjcore/vrfobjcoreDefines.h"

class DtPlan;
class DtPlanExecutor;
class DtSimBlock;
class DtSimCondExpr;
class DtSimMessage;
class DtSimulationAddress;
class DtVrfObjectMessage;
class DtIfPlan;
class DtTaskMessage;
class DtLocalObject;

class DT_DLL_vrfobjcore DtVrfObjectPlanManager 
{
public:

   DtVrfObjectPlanManager(DtLocalObject* vrfObject);

   virtual ~DtVrfObjectPlanManager();

   virtual bool init();

   virtual void tick();

   virtual DtPlanExecutor* createPlanExecutor();

   virtual DtPlan* createAndInitPlan();

   virtual DtPlan* plan();
   
   virtual DtPlan* getOrCreatePlan();

   virtual DtPlan* nextFramePlan();

   virtual void setPlan(DtPlan* plan, bool abandonCurrentPlan = true);

   virtual bool sendPlan();

   virtual bool sendPlanStatement(int statementId, 
      const DtSimulationAddress& address) const;

   virtual void setTaskIssuedFromPlan(bool taskIssuedFromPlan);
   
   virtual void taskExecuted(const DtTaskMessage& msg, bool abandonPlan = true);

   static DtVrfObjectPlanManagerFactory* factory();
   static void setFactory(DtVrfObjectPlanManagerFactory* factory);

   virtual void processSetPlan(DtSimMessage* msg);
   virtual void processSetPlan(DtIfPlan* msgData);

   virtual void prepareForReinitialization();

   virtual void processRequestPlan(const DtSimMessage* msg);

   virtual void processAbandonPlan(DtSimMessage* msg);

   virtual void processRestartPlan(DtSimMessage* msg);

   virtual void restartPlan();

   static void currentStatementChangedCallback(const DtPlan& plan, 
      void* usrData);
   virtual void processCurrentStatementChanged(const DtPlan& plan);

   static DtVrfObjectPlanManager* creator(DtLocalObject* vrfObject);

   static DtVrfObjectPlanManager* createVrfObjectPlanManager(
      const DtString& type, DtLocalObject* vrfObject);

   virtual bool hasPlan() const;

   virtual bool isGlobalPlan() const;

   virtual bool executingPlan() const;

   virtual void notifyTaskCompletion(int taskId);

   virtual void notifySkipTask();

   virtual bool taskAbandonsPlan(const DtTaskMessage& tskMsg) const;

protected:

   DtVrfObjectPlanManager();

   DtVrfObjectPlanManager(const DtVrfObjectPlanManager& orig);

   DtVrfObjectPlanManager& operator=(const DtVrfObjectPlanManager& orig);

protected:

   DtPlan* myPlan;
   DtPlanExecutor* myPlanExecutor;
   DtLocalObject* myVrfObject;
   bool myTaskIssuedFromPlan;
   bool myPlanQueuedForAbandonment;
   bool myIsRegisteredForCallback;

   static DtVrfObjectPlanManagerFactory* theFactory;
   DtPlan* myPendingReplacementPlan = nullptr;
};