 |
VR-Forces 4.1.1 Class Documentation
|
|
VR-Forces 4.1.1 Class Documentation
|
class DtWhileBlock: More...
Public Member Functions | |
| DtWhileBlock (DtWhileStmt *whileStmt=NULL) | |
| default constructor | |
| DtWhileBlock (const DtString &name, DtWhileStmt *whileStmt=NULL, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtWhileBlock (const DtWhileBlock &orig) | |
| Default copy constructor. | |
| DtWhileBlock (const DtString &name, const DtWhileBlock &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Better copy constructor. | |
| virtual | ~DtWhileBlock () |
| destructor | |
| DtWhileBlock & | operator= (const DtWhileBlock &orig) |
| assignment operator | |
| virtual DtSimBlock * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const |
| The normal clone function. | |
| virtual void | exitFromBlock (DtPlan &planContext) |
| Re-evaluates the while loop's conditional expression and if true executes the block again. | |
| virtual void | setWhileStmt (DtWhileStmt *arg) |
| Set this block's while statement. | |
| virtual const DtWhileStmt * | whileStmt () const |
| Get this block's while statement. | |
| virtual DtWhileStmt * | whileStmt () |
| Get this block's while statement. | |
 Public Member Functions inherited from DtSimBlock | |
| DtSimBlock () | |
| default constructor | |
| DtSimBlock (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtSimBlock (const DtSimBlock &orig) | |
| default copy constructor NOTE: this does a deep copy of the statements. | |
| DtSimBlock (const DtString &name, const DtSimBlock &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| better copy constructor NOTE: this does a deep copy of the statements. | |
| virtual | ~DtSimBlock () |
| destructor NOTE: this DELETES the contained statements. | |
| DtSimBlock & | operator= (const DtSimBlock &orig) |
| assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones. | |
| DtSimBlock * | clone () const |
| This clone re-uses the current DtSimBlock's name, but does not register in its parent's plan or registry. | |
| DtSimStatement * | firstStmt () const |
| Same as firstObj(), except also downcasts. | |
| DtSimStatement * | lastStmt () const |
| Same as lastObj(), except also downcasts. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| This special version of getData creates the necessary list element object using the DtSimStatement::statementFactory, tells the statement to getSelf, and then adds the statement to the DtRwIntrusiveList. | |
| virtual bool | translateIndex (DtStmtIndex &stmtIndex) const |
| If you have a DtStmtIndex object that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndex function to convert it to point into this Block. | |
| virtual void | translateIndices (DtList &stmtIndexList) const |
| If you have a list of DtStmtIndex objects that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndicies function to convert them to point into this Block. | |
| virtual DtSimStatement * | lookupStatement (DtStmtIdType statementId) |
| Looks up a statement with the given Id. | |
| virtual DtRecursiveSimBlockIterator * | spawnRecursiveIterator () const |
| Spawns an iterator that iterates over the elements in this sim block, and all their children, sub children, etc. | |
| virtual bool | validate () |
| Calls validate() on all statements within the block. | |
| virtual bool | isSameBlock (DtSimBlock *rhs) |
| Returns true if all sub statements are the same. | |
| Public Member Functions inherited from DtRwIntrusiveList | |
| DtRwIntrusiveList () | |
| default constructor | |
| DtRwIntrusiveList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtRwIntrusiveList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwIntrusiveList (const DtString &name, const DtRwIntrusiveList &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Invokes DtReaderWriter copy constructor. Elements are not copied. | |
| DtRwIntrusiveList (const DtSymbolString &name, const DtRwIntrusiveList &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual | ~DtRwIntrusiveList () |
| destructor Note: for consistency with other list classes, this destructor will NOT delete the data objects contained by the list. | |
| DtRwIntrusiveList & | operator= (const DtRwIntrusiveList &orig) |
| Calls down to DtReaderWriter::operator=(). List elements are not copied. | |
| DtRwListedObj * | firstObj () const |
| Return first and last item on the list. | |
| DtRwListedObj * | lastObj () const |
| DtListItem * | first () const |
| Return first and last item on the list. | |
| DtListItem * | last () const |
| unsigned | count () const |
| Returns the number of elements in the list. | |
| DtListItem * | add (DtRwListedObj *data) |
| Add element to the end of the list. | |
| DtListItem * | addToStart (DtRwListedObj *data) |
| Add element to the beginning of the list. | |
| DtListItem * | addToEnd (DtRwListedObj *data) |
| Add element to the end of the list. | |
| DtListItem * | addBefore (DtRwListedObj *data, DtRwListedObj *before) |
| Add element to the list just before the indicated object. | |
| DtListItem * | addAfter (DtRwListedObj *data, DtRwListedObj *after) |
| Add element to the list just after the indicated object. | |
| DtRwListedObj * | remove (DtRwListedObj *data) |
| Remove an element from the list. | |
| virtual DtRwListedObj * | remove (DtListItem *item) |
| Remove an element from the list. | |
| void | removeAndDelete (DtRwListedObj *data) |
| Remove and delete an element from the list. | |
| virtual void | removeAndDelete (DtListItem *item) |
| Remove and delete an element from the list. | |
| virtual void | removeAll () |
| Calls remove for all elements in the list. | |
| virtual void | removeAllAndDelete () |
| Same as removeAll, except that this DOES delete the data in the list. | |
| DtListItem * | itemLookup (DtRwListedObj *data) const |
| Returns the DtListItem envelope object containing the indicated data element. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Reads the contents of the list, using the list-specific getData function below. | |
| virtual DtlObjPtr | getLocalData (DtlObjPtr args) |
| Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual bool | isReadonly () const |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Protected Attributes | |
| DtWhileStmt * | myWhileStmt |
Additional Inherited Members | |
| Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (FILE *fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static DtReaderWriterFactory * | factory () |
| Protected Member Functions inherited from DtSimBlock | |
| virtual DtListItem * | addToList (DtRwListedObj *data, DtRwListedObj *after) |
| Add element to the list just after the indicated item. | |
| virtual void | cloneListFrom (const DtSimBlock &other) |
| This function will clone the statements from the given statement list. | |
| Static Protected Attributes inherited from DtReaderWriter | |
| static DtString | theUnspecifiedValue |
| static DtGetSelfCallbackInfo | thePostGetSelfCallback |
| static DtPutSelfCallbackInfo | thePrePutSelfCallback |
| static const DtVariableBindingsList | theEmptyVariableBindingsList |
| static DtReaderWriterFactory | theFactory |
class DtWhileBlock:
Instances of DtWhileBlock hold statements that are nested inside a while loop.
| DtWhileBlock::DtWhileBlock | ( | DtWhileStmt * | whileStmt = NULL | ) |
default constructor
| DtWhileBlock::DtWhileBlock | ( | const DtString & | name, |
| DtWhileStmt * | whileStmt = NULL, |
||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
real constructor
| DtWhileBlock::DtWhileBlock | ( | const DtWhileBlock & | orig | ) |
Default copy constructor.
NOTE: this does a deep copy of the statements.
| DtWhileBlock::DtWhileBlock | ( | const DtString & | name, |
| const DtWhileBlock & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Better copy constructor.
NOTE: this does a deep copy of the statements.
|
virtual |
destructor
| DtWhileBlock& DtWhileBlock::operator= | ( | const DtWhileBlock & | orig | ) |
assignment operator
|
virtual |
The normal clone function.
Implements DtSimBlock.
|
virtual |
Re-evaluates the while loop's conditional expression and if true executes the block again.
If not, the plan's execution stack is popped.
Implements DtSimBlock.
|
virtual |
Set this block's while statement.
|
virtual |
Get this block's while statement.
|
virtual |
Get this block's while statement.
|
protected |