VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
doUntilStmt.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2021 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrfplan/rwCondExpr.h"
13 
14 #include <vlutil/vlNetTypes.h>
15 
16 const char DtDoUntilStmtTypeName[] = "DoUntil";
17 
18 class DtRwCondExpr;
19 class DtDoUntilBlock;
20 class DtSimCondExpr;
21 //class DtSimMessage;
22 
30 #include "vrfplan/vrfplanDefines.h"
32 {
33 public:
34 
36  DtDoUntilStmt(DtReaderWriterRegistry* parentRegistry = NULL);
37 
39  DtDoUntilStmt(const DtDoUntilStmt& orig,
40  DtReaderWriterRegistry* parentRegistry = NULL);
41 
43  virtual ~DtDoUntilStmt() override;
44 
47 
49  virtual DtSimStatement* clone(DtReaderWriterRegistry* parentRegistry = NULL) const override;
50 
52  virtual int type() const override;
53 
57  virtual bool validate() override;
58 
61  virtual void execute(DtPlan& planContext) override;
62 
64  virtual int subBlockCount() const override;
66  virtual DtSimBlock* subBlock(int index) override;
67 
77  virtual DtString stringRep(int subBlockIndex = DtSR_STMT) const override;
78 
80  virtual const DtSimCondExpr* condExpr() const override;
82  virtual void setCondExpr(const DtSimCondExpr* arg) override;
83 
84  virtual DtDoUntilBlock* doUntilBlock() const;
85  virtual void setDoUntilBlock(DtDoUntilBlock* arg);
86 
89  virtual int netRepSize() const override;
90 
92  virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
93 
105  virtual bool setToNet() override;
106 
108  virtual void upgradeTriggerUUID(const boost::unordered_map<DtUUID, DtUUID>&) override;
109 
111  virtual void reset() override;
112 
114  static void evaluateCondExprCallback(DtPlan& plan, void* usrData);
115 
118  static void skipTaskCallback(void * usr);
119 
120 public:
122  static DtSimStatement* creator(DtReaderWriterRegistry* parentRegistry=NULL);
123 
124 protected:
125  virtual bool compare(DtSimStatement* rhs) override;
128  void interrupt(DtPlan& planContext);
131  virtual void evaluateConditional(DtPlan& planContext);
132  virtual void skipTask();
133 
134 protected:
135 
139 };
virtual void setCondExpr(const DtSimCondExpr *arg)=0
Sets the conditional expression used to evaluate the wait until.
virtual DtSimStatement * clone(DtReaderWriterRegistry *parentRegistry=NULL) const =0
virtual copy constructor A typical clone function. It must be overridden by derived classes to return...
virtual int subBlockCount() const
Get the number of blocks nested inside this statement.
const char DtDoUntilStmtTypeName[]
Definition: doUntilStmt.h:16
virtual void execute(DtPlan &planContext)=0
Execute the current statement and make any changes to the Plan state as appropriate. Tells the statement to activate its own behavior. Each kind of statement implements this function differently. It is passed a reference to the executing DtPlan object as a “context of execution”.
virtual void reset() override
Called when the plan is reset, will iterate over all statements to reset as well. ...
Definition: readerWriterRegistry.h:39
bool myIsSkipped
Definition: doUntilStmt.h:138
class DtDoUntilStmt:
Definition: doUntilStmt.h:31
DtDoUntilBlock * myBlock
Definition: doUntilStmt.h:137
class DtSimBlock:
Definition: simBlock.h:27
class DtSimConditionalStatement:
Definition: simConditionalStatement.h:25
virtual DtSimBlock * subBlock(int index)
Get a pointer to any particular block nested inside this statement. Sub-blocks are indexed as C array...
DtRwCondExpr myCondExpr
Definition: doUntilStmt.h:136
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Extracts statement Id from buffer. First 16 bytes are a DtNetSimStatement structure. Derived class data should immediately follow this. Derived classes should call down to this one to make sure statement id gets set.
virtual int netRepSize() const
Returns sizeof(DtNetSimStatement). Derived classes should add this size to the size of their net repr...
class DtPlan:
Definition: plan.h:92
DtSimCondExpr is an abstract base class representing various Conditional Expressions used by the Plan...
Definition: simCondExpr.h:53
class DtDoUntilBlock:
Definition: doUntilBlock.h:26
class DtRwCondExpr:
Definition: rwCondExpr.h:26
class DtSimStatement:
Definition: simStatement.h:38
virtual bool setToNet()
Casts myNetRep to DtNetSimStatement* and fills in structure. Derived classes should always call down ...
virtual bool validate()
Checks the statement for validity, and potentially fixes the statement to be valid.
#define DT_DLL_vrfplan
This file is used to determine how to build.
Definition: vrfplanDefines.h:28
virtual void upgradeTriggerUUID(const boost::unordered_map< DtUUID, DtUUID > &)
For those statements that need to, map from the old to new trigger UUID.
virtual const DtSimCondExpr * condExpr() const =0
Returns the conditional expression used to evaluate the wait until.
DtSimStatement & operator=(const DtSimStatement &orig)
Assignment operator (protected because this is an abstract base class).
virtual int type() const =0
Returns the type of statement Type (defined in simStmtTypes.h)
virtual bool compare(DtSimStatement *)
Called from isSameStatement. Compares net reps to see if they are the same. Override to do different ...
virtual DtString stringRep(int subBlockIndex=DtSR_STMT) const =0
Get a readable string representation of this statement.

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)