 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
8 bytes total More...
Public Member Functions | |
| DtWhileStmt (DtReaderWriterRegistry *parentRegistry=NULL) | |
| default constructor | |
| DtWhileStmt (const DtWhileStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| virtual | ~DtWhileStmt () |
| destructor | |
| DtWhileStmt & | operator= (const DtWhileStmt &orig) |
| assignment operator | |
| virtual DtSimStatement * | clone (DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual copy constructor | |
| virtual int | type () const |
| Returns DtWhileStatementType (defined in simStmtTypes.h) | |
| virtual bool | validate () |
| Checks to see if the while block is empty, and if so, adds a noop statement to it. | |
| virtual void | execute (DtPlan &planContext) |
| Evaluates the conditional expression and if true pushes the plan's execution stack and executes the while block. | |
| virtual int | subBlockCount () const |
| While statements only support one block, so this always returns one. | |
| virtual DtSimBlock * | subBlock (int index) |
| If the first block (index 0) is requested, myBlock is returned. | |
| virtual DtString | stringRep (int subBlockIndex=DtSR_STMT) const |
| Get a readable string representation of this While statement. | |
| virtual const DtSimCondExpr * | condExpr () const |
| Returns the conditional expression used to evaluate the while. | |
| virtual void | setCondExpr (DtSimCondExpr *arg) |
| Sets the conditional expression used to evaluate the while. | |
| virtual DtWhileBlock * | whileBlock () const |
| virtual void | setWhileBlock (DtWhileBlock *arg) |
| virtual int | netRepSize () const |
| Returns the size of the full network representation padded to an 8-byte boundary. | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Fills in the request from the network buffer. | |
| virtual bool | setToNet () |
| Fills in the network buffer (created by base class sim statement) with the set data request contents. | |
Static Public Member Functions | |
| static DtSimStatement * | creator (DtReaderWriterRegistry *parentRegistry=NULL) |
| Creator function to be registered with DtStatementFactory. | |
Protected Member Functions | |
| virtual bool | compare (DtSimStatement *rhs) |
| Called from isSameStatement. | |
Protected Attributes | |
| DtRwCondExpr | myCondExpr |
| DtWhileBlock * | myBlock |
8 bytes total
class DtWhileStmt:
Instances of DtWhileStmt represent a while loop. They contain one conditional expression and one sub-block which will be executed as long as the condition evaluates to True.
| DtWhileStmt::DtWhileStmt | ( | DtReaderWriterRegistry * | parentRegistry = NULL | ) |
default constructor
| DtWhileStmt::DtWhileStmt | ( | const DtWhileStmt & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
| virtual DtWhileStmt::~DtWhileStmt | ( | ) | [virtual] |
destructor
| DtWhileStmt& DtWhileStmt::operator= | ( | const DtWhileStmt & | orig | ) |
assignment operator
| virtual DtSimStatement* DtWhileStmt::clone | ( | DtReaderWriterRegistry * | parentRegistry = NULL | ) | const [virtual] |
virtual copy constructor
Implements DtSimStatement.
| virtual int DtWhileStmt::type | ( | ) | const [virtual] |
Returns DtWhileStatementType (defined in simStmtTypes.h)
Implements DtSimStatement.
| virtual bool DtWhileStmt::validate | ( | ) | [virtual] |
Checks to see if the while block is empty, and if so, adds a noop statement to it.
The plan executor cannot handle empty while blocks.
Reimplemented from DtSimStatement.
| virtual void DtWhileStmt::execute | ( | DtPlan & | planContext | ) | [virtual] |
Evaluates the conditional expression and if true pushes the plan's execution stack and executes the while block.
Implements DtSimStatement.
| virtual int DtWhileStmt::subBlockCount | ( | ) | const [virtual] |
While statements only support one block, so this always returns one.
Reimplemented from DtSimStatement.
| virtual DtSimBlock* DtWhileStmt::subBlock | ( | int | index | ) | [virtual] |
If the first block (index 0) is requested, myBlock is returned.
Reimplemented from DtSimStatement.
| virtual DtString DtWhileStmt::stringRep | ( | int | subBlockIndex = DtSR_STMT | ) | const [virtual] |
Get a readable string representation of this While statement.
The subBlockIndex argument indicates which stringRep to get as a prefix for a given sub-block. For a While statement, the first (0) sub-block's prefix is the "while (...) do" part, and if a subBlockIndex value of DtSimStatement::DtSR_STMT is given, the "endwhile" part is returned.
See the documentation for DtSimStatement::stringRep for more information.
Implements DtSimStatement.
| virtual const DtSimCondExpr* DtWhileStmt::condExpr | ( | ) | const [virtual] |
Returns the conditional expression used to evaluate the while.
| virtual void DtWhileStmt::setCondExpr | ( | DtSimCondExpr * | arg | ) | [virtual] |
Sets the conditional expression used to evaluate the while.
| virtual DtWhileBlock* DtWhileStmt::whileBlock | ( | ) | const [virtual] |
| virtual void DtWhileStmt::setWhileBlock | ( | DtWhileBlock * | arg | ) | [virtual] |
| virtual int DtWhileStmt::netRepSize | ( | ) | const [virtual] |
Returns the size of the full network representation padded to an 8-byte boundary.
Reimplemented from DtSimStatement.
| virtual bool DtWhileStmt::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Fills in the request from the network buffer.
Reimplemented from DtSimStatement.
| virtual bool DtWhileStmt::setToNet | ( | ) | [virtual] |
Fills in the network buffer (created by base class sim statement) with the set data request contents.
Network buffer is filled in as follows:
DtNetSimStatement DtNetWhileStatment <statement data 1> . . . <statement data="" n>="">
n is the number of top-level statements in the while block, and statement data is the net representation of a DtSimStatement.
Reimplemented from DtSimStatement.
| static DtSimStatement* DtWhileStmt::creator | ( | DtReaderWriterRegistry * | parentRegistry = NULL | ) | [static] |
Creator function to be registered with DtStatementFactory.
| virtual bool DtWhileStmt::compare | ( | DtSimStatement * | ) | [protected, virtual] |
Called from isSameStatement.
Compares net reps to see if they are the same. Override to do different comparrison
Reimplemented from DtSimStatement.
DtRwCondExpr DtWhileStmt::myCondExpr [protected] |
DtWhileBlock* DtWhileStmt::myBlock [protected] |