VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ifPlan.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 #include <vlutil/vlString.h>
13 #include <vlutil/vlNetTypes.h>
14 #include <vlutil/vlList.h>
15 #include "vrfplan/simStatement.h"
16 #include "vrfplan/rwTriggersList.h"
17 #include "vrfplan/plan.h"
18 #include <vrfutil/rwUUID.h>
19 
20 class DtPlan;
21 class DtSimBlock;
22 class DtSimStatement;
23 
45 
59 
60 #include "vrfmsgs/vrfmsgsDefines.h"
62 {
63 public:
64 
66  DtIfPlan();
67 
69  virtual ~DtIfPlan() override;
70 
72  DtIfPlan(const DtIfPlan& orig);
73 
75  DtIfPlan& operator=(const DtIfPlan& orig);
76 
78  virtual int type() const override;
79 
80  virtual DtSimInterfaceContent * clone() const override;
81 
87  virtual const DtUUID & planName() const;
88 
90  virtual void setPlanName(const DtUUID & name);
91 
92  virtual DtString markingText() const;
93 
96 
97  virtual bool isGlobal() const;
98  virtual void setIsGlobal(bool yesNo);
100 
108  virtual bool addStatement(const DtSimStatement& statement);
109 
111  virtual const std::vector<DtSimStatement*>& statements() const;
112 
114  virtual const DtRwTriggersList& triggers() const;
115 
117  virtual void addTrigger(const DtTriggerStmt&);
118 
120  virtual void setTriggers(const DtRwTriggersList&);
121 
123  virtual void setVariables(const DtRwVariableBindings&);
124  const DtRwVariableBindings& variables() const { return myVariables; };
125  DtRwVariableBindings& variables() { return myVariables; };
126 
131  virtual void setAssign(bool flag);
132  virtual bool assign() const;
133 
137  virtual int netRepSize() const override;
138 
140  virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
141 
144  virtual bool setToNet() override;
145 
146  virtual void printDataToString(DtString& str) override;
147 
148  static DtSimInterfaceContent* creator();
149 
152  void emptyStatementList();
153 
155  virtual bool isSamePlan(DtIfPlan* rhs);
156 
159  virtual void setAbandonCurrentPlan(bool);
160  virtual bool abandonCurrentPlan() const;
161 
166  virtual void setIsQuickLaunch(bool);
167  virtual bool isQuickLaunch() const;
168 
169  virtual void setShowOnQuickLaunchToolbar(bool);
170  virtual bool showOnQuickLaunchToolbar() const;
171 
172  virtual void setQuickLaunchIcon(const DtString&);
173  virtual const DtString& quickLaunchIcon() const;
174 
175  virtual void setOrdinal(int);
176  virtual int ordinal() const;
177 
178  virtual void setPlanSummary(const DtString&);
179  virtual const DtString& planSummary() const;
180 
182 
183  virtual void setSendPlanOnAssignment(bool);
184  virtual bool sendPlanOnAssignment() const;
185 
186  virtual void setPlanFromMessage(DtPlan& plan) const;
187 
190  virtual void upgradeTriggerUUIDs();
191 
192 protected:
193 
197  void copyStatementList(const std::vector<DtSimStatement*>& otherList);
198 
199 protected:
200 
202 
205  std::vector<DtSimStatement*> myStatementList;
206 
209 
213 
215 
218  DtU32 myOrdinal;
220 
223 
227 
231 };
class DtIfPlan:
Definition: ifPlan.h:61
UUID is a unique ID wrapper class.
Definition: uuid.h:59
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Definition: simInterfaceContent.h:78
bool myAppendFlag
Indicates if message is used to create new or append to existing plan.
Definition: ifPlan.h:208
virtual int netRepSize() const
Definition: simInterfaceContent.h:76
#define DT_DLL_vrfmsgs
This file is used to determine how to build.
Definition: vrfmsgsDefines.h:28
virtual int type() const =0
bool mySendPlanOnAssignment
When the plan is set in the plan manager send the plan out on the network so front-ends can receive i...
Definition: ifPlan.h:230
DtRwTriggersList myTriggers
Definition: ifPlan.h:224
DtRwVariableBindings myVariables
Definition: ifPlan.h:225
std::vector< DtSimStatement * > myStatementList
List of top-level DtSimStatement*s. Individual statements may contain nested statements.
Definition: ifPlan.h:205
DtU32 myOrdinal
Definition: ifPlan.h:218
Contains the DtUUID class declaration.
const DtRwVariableBindings & variables() const
Definition: ifPlan.h:124
ReaderWriter object that maintains a list of reader-writer variable bindings. It keeps a list of name...
Definition: rwVariableBindings.h:27
virtual void printDataToString(DtString &str)
class DtSimBlock:
Definition: simBlock.h:27
bool myAbandonCurrentPlan
Definition: ifPlan.h:226
DtU32 myQuickLaunchFlags
Information that are used for global plans only.
Definition: ifPlan.h:217
DtString myPlanSummary
Information that is currently used for synchronization matrices plans only.
Definition: ifPlan.h:222
const DtSimInterfaceContent & operator=(const DtSimInterfaceContent &orig)
class DtPlan:
Definition: plan.h:92
DtString myQuickLaunchIcon
Definition: ifPlan.h:219
DtUUID myPlanName
Definition: ifPlan.h:201
bool myAssignFlag
Indicates whether the receiver should assign this plan to the object or whether the message represent...
Definition: ifPlan.h:212
class DtSimStatement:
Definition: simStatement.h:38
virtual bool setToNet()
Definition: simInterfaceContent.h:83
Definition: simInterfaceContent.h:45
Definition: triggerStmt.h:63
virtual DtSimInterfaceContent * clone() const =0
bool myIsGlobal
Definition: ifPlan.h:214
Instances of DtRwTriggersList are lists of readable, writeable when statements (triggers) The list co...
Definition: rwTriggersList.h:21
DtRwVariableBindings & variables()
Definition: ifPlan.h:125

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)