ifPlan.h

Go to the documentation of this file.

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


#pragma once

#include <vlutil/vlString.h>
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vlutil/vlNetTypes.h>
#include <vlutil/vlList.h>
#include "vrfplan/simStatement.h"
#include "vrfplan/rwTriggersList.h"
#include "vrfplan/plan.h"
#include <vrfutil/rwUUID.h>

class DtPlan;
class DtSimBlock;
class DtSimStatement;



#include "vrfmsgs/vrfmsgsDefines.h"
class DT_DLL_vrfmsgs DtIfPlan : public DtSimInterfaceContent
{
public:

   DtIfPlan();

   virtual ~DtIfPlan();

   DtIfPlan(const DtIfPlan& orig);

   DtIfPlan& operator=(const DtIfPlan& orig);

   virtual int type() const;

   virtual DtSimInterfaceContent * clone() const;

   virtual const DtUUID & planName() const;

   virtual void setPlanName(const DtUUID & name);

   virtual DtString markingText() const;


   virtual bool isGlobal() const;
   virtual void setIsGlobal(bool yesNo);

   virtual bool addStatement(const DtSimStatement& statement);

   virtual const std::vector<DtSimStatement*>& statements() const;

   virtual const DtRwTriggersList& triggers() const;

   virtual void addTrigger(const DtTriggerStmt&);

   virtual void setTriggers(const DtRwTriggersList&);

   virtual void setVariables(const DtRwVariableBindings&);
   const DtRwVariableBindings& variables() const { return myVariables; };
   DtRwVariableBindings& variables() { return myVariables; };

   virtual void setAssign(bool flag);
   virtual bool assign() const;

   virtual int netRepSize() const;

   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);

   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

   void emptyStatementList();

   virtual bool isSamePlan(DtIfPlan* rhs);

   virtual void setAbandonCurrentPlan(bool);
   virtual bool abandonCurrentPlan() const;

   virtual void setIsQuickLaunch(bool);
   virtual bool isQuickLaunch() const;

   virtual void setShowOnQuickLaunchToolbar(bool);
   virtual bool showOnQuickLaunchToolbar() const;

   virtual void setQuickLaunchIcon(const DtString&);
   virtual const DtString& quickLaunchIcon() const;

   virtual void setOrdinal(int);
   virtual int ordinal() const;

   virtual void setPlanSummary(const DtString&);
   virtual const DtString& planSummary() const;
   

   virtual void setSendPlanOnAssignment(bool);
   virtual bool sendPlanOnAssignment() const;

   virtual void setPlanFromMessage(DtPlan& plan) const;

   virtual void upgradeTriggerUUIDs();

protected:

   void copyStatementList(const std::vector<DtSimStatement*>& otherList);

protected:

   mutable DtUUID myPlanName;

   std::vector<DtSimStatement*> myStatementList;

   bool myAppendFlag;

   bool myAssignFlag;

   bool myIsGlobal;

   DtU32 myQuickLaunchFlags;
   DtU32 myOrdinal;
   DtString myQuickLaunchIcon;

   DtString myPlanSummary;

   DtRwTriggersList myTriggers;
   DtRwVariableBindings myVariables;
   bool myAbandonCurrentPlan;

   bool mySendPlanOnAssignment;
};