VR-Forces 5.0.2 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();
70 
72  DtIfPlan(const DtIfPlan& orig);
73 
75  DtIfPlan& operator=(const DtIfPlan& orig);
76 
78  virtual int type() const;
79 
80  virtual DtSimInterfaceContent * clone() const;
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;
138 
140  virtual bool setFromNet(const char* contentBuffer,
141  unsigned contentSize);
142 
145  virtual bool setToNet();
146 
147  virtual void printDataToString(DtString& str);
148 
149  static DtSimInterfaceContent* creator();
150 
153  void emptyStatementList();
154 
156  virtual bool isSamePlan(DtIfPlan* rhs);
157 
162  virtual void setIsQuickLaunch(bool);
163  virtual bool isQuickLaunch() const;
164 
165  virtual void setShowOnQuickLaunchToolbar(bool);
166  virtual bool showOnQuickLaunchToolbar() const;
167 
168  virtual void setQuickLaunchIcon(const DtString&);
169  virtual const DtString& quickLaunchIcon() const;
170 
171  virtual void setOrdinal(int);
172  virtual int ordinal() const;
173 
174  virtual void setPlanSummary(const DtString&);
175  virtual const DtString& planSummary() const;
176 
178 
179  virtual void setPlanFromMessage(DtPlan& plan) const;
180 
183  virtual void upgradeTriggerUUIDs();
184 
185 protected:
186 
190  void copyStatementList(const std::vector<DtSimStatement*>& otherList);
191 
192 protected:
193 
195 
198  std::vector<DtSimStatement*> myStatementList;
199 
202 
206 
208 
211  DtU32 myOrdinal;
213 
216 
219 };
class DtIfPlan:
Definition: ifPlan.h:61
UUID is a unique ID wrapper class.
Definition: rwUUID.h:229
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:201
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
DtRwTriggersList myTriggers
Definition: ifPlan.h:217
DtRwVariableBindings myVariables
Definition: ifPlan.h:218
std::vector< DtSimStatement * > myStatementList
List of top-level DtSimStatement*s. Individual statements may contain nested statements.
Definition: ifPlan.h:198
DtU32 myOrdinal
Definition: ifPlan.h:211
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
DtU32 myQuickLaunchFlags
Information that are used for global plans only.
Definition: ifPlan.h:210
DtString myPlanSummary
Information that is currently used for synchronization matrices plans only.
Definition: ifPlan.h:215
const DtSimInterfaceContent & operator=(const DtSimInterfaceContent &orig)
class DtPlan:
Definition: plan.h:92
DtString myQuickLaunchIcon
Definition: ifPlan.h:212
DtUUID myPlanName
Definition: ifPlan.h:194
bool myAssignFlag
Indicates whether the receiver should assign this plan to the object or whether the message represent...
Definition: ifPlan.h:205
class DtSimStatement:
Definition: simStatement.h:38
virtual bool setToNet()
Definition: simInterfaceContent.h:83
Definition: simInterfaceContent.h:45
Definition: triggerStmt.h:60
virtual DtSimInterfaceContent * clone() const =0
bool myIsGlobal
Definition: ifPlan.h:207
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 Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)