 |
VR-Forces 4.10 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.10 Class Documentation
|
class DtWhileBlock: More...
Public Member Functions | |
| DtWhileBlock (DtWhileStmt *whileStmt=NULL) | |
| default constructor More... | |
| DtWhileBlock (const DtString &name, DtWhileStmt *whileStmt=NULL, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor More... | |
| DtWhileBlock (const DtWhileBlock &orig) | |
| Default copy constructor. More... | |
| DtWhileBlock (const DtString &name, const DtWhileBlock &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Better copy constructor. More... | |
| virtual | ~DtWhileBlock () |
| destructor More... | |
| DtWhileBlock & | operator= (const DtWhileBlock &orig) |
| assignment operator More... | |
| virtual DtSimBlock * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const |
| The normal clone function. More... | |
| virtual void | exitFromBlock (DtPlan &planContext) |
| Re-evaluates the while loop's conditional expression and if true executes the block again. More... | |
| virtual const DtWhileStmt * | whileStmt () const |
| Get this block's while statement. More... | |
| virtual DtWhileStmt * | whileStmt () |
| Get this block's while statement. More... | |
 Public Member Functions inherited from DtSimBlock | |
| DtSimBlock (DtSimStatement *parentStatement) | |
| default constructor More... | |
| DtSimBlock (const DtString &name, DtSimStatement *parentStatement, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor More... | |
| DtSimBlock (const DtSimBlock &orig) | |
| default copy constructor NOTE: this does a deep copy of the statements. More... | |
| DtSimBlock (const DtString &name, const DtSimBlock &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| better copy constructor NOTE: this does a deep copy of the statements. More... | |
| virtual | ~DtSimBlock () |
| destructor NOTE: this DELETES the contained statements. More... | |
| DtSimBlock & | operator= (const DtSimBlock &orig) |
| assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones. More... | |
| DtSimBlock * | clone () const |
| This clone re-uses the current DtSimBlock's name, but does not register in its parent's plan or registry. More... | |
| DtSimStatement * | firstStmt () const |
| Same as firstObj(), except also downcasts. More... | |
| DtSimStatement * | lastStmt () const |
| Same as lastObj(), except also downcasts. More... | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, 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. More... | |
| virtual bool | translateIndex (DtStmtIndex &stmtIndex) |
| 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. More... | |
| virtual void | translateIndices (DtList &stmtIndexList) |
| 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. More... | |
| virtual DtSimStatement * | lookupStatement (DtStmtIdType statementId) |
| Looks up a statement with the given Id. More... | |
| virtual DtRecursiveSimBlockIterator * | spawnRecursiveIterator () const |
| Spawns an iterator that iterates over the elements in this sim block, and all their children, sub children, etc. More... | |
| virtual bool | validate () |
| Calls validate() on all statements within the block. More... | |
| virtual bool | isSameBlock (DtSimBlock *rhs) |
| Returns true if all sub statements are the same. More... | |
| void | setParentStatement (DtSimStatement *) |
| Sets the parent statement of this block. More... | |
| DtSimStatement * | parentStatement () const |
| Returns parent statement of this block. More... | |
| virtual DtListItem * | addToList (DtRwListedObj *data, DtRwListedObj *after) |
| Add element to the list just after the indicated item. More... | |
| virtual void | upgradeTriggerUUID (const boost::unordered_map< DtUUID, DtUUID > &) |
| For those statements that need to, map from the old to new trigger UUID. More... | |
| virtual void | reset () |
| Called when the plan is reset, will iterate over all statements to reset as well. More... | |
| Public Member Functions inherited from DtRwIntrusiveList | |
| DtRwIntrusiveList () | |
| default constructor More... | |
| DtRwIntrusiveList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor More... | |
| 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. More... | |
| 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. More... | |
| DtRwIntrusiveList & | operator= (const DtRwIntrusiveList &orig) |
| Calls down to DtReaderWriter::operator=(). List elements are not copied. More... | |
| DtRwListedObj * | firstObj () const |
| Return first and last item on the list. More... | |
| DtRwListedObj * | lastObj () const |
| DtListItem * | first () const |
| Return first and last item on the list. More... | |
| DtListItem * | last () const |
| unsigned | count () const |
| Returns the number of elements in the list. More... | |
| DtListItem * | add (DtRwListedObj *data) |
| Add element to the end of the list. More... | |
| DtListItem * | addToStart (DtRwListedObj *data) |
| Add element to the beginning of the list. More... | |
| DtListItem * | addToEnd (DtRwListedObj *data) |
| Add element to the end of the list. More... | |
| DtListItem * | addBefore (DtRwListedObj *data, DtRwListedObj *before) |
| Add element to the list just before the indicated object. More... | |
| DtListItem * | addAfter (DtRwListedObj *data, DtRwListedObj *after) |
| Add element to the list just after the indicated object. More... | |
| DtRwListedObj * | remove (DtRwListedObj *data) |
| Remove an element from the list. More... | |
| virtual DtRwListedObj * | remove (DtListItem *item) |
| Remove an element from the list. More... | |
| void | removeAndDelete (DtRwListedObj *data) |
| Remove and delete an element from the list. More... | |
| virtual void | removeAndDelete (DtListItem *item) |
| Remove and delete an element from the list. More... | |
| virtual void | removeAll () |
| Calls remove for all elements in the list. More... | |
| virtual void | removeAllAndDelete () |
| Same as removeAll, except that this DOES delete the data in the list. More... | |
| DtListItem * | itemLookup (DtRwListedObj *data) const |
| Returns the DtListItem envelope object containing the indicated data element. More... | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Reads the contents of the list, using the list-specific getData function below. More... | |
| 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. More... | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor More... | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. More... | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor More... | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator More... | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. More... | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor More... | |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. More... | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. More... | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. More... | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. More... | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. More... | |
| virtual void | writeSelf (std::string &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. More... | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. More... | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. More... | |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. More... | |
| bool | isReadonly () const |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. More... | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. More... | |
| virtual void | setName (const DtString &) |
| Set the name of the object. More... | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. More... | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. More... | |
| 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. More... | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. More... | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More... | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. More... | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. More... | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. More... | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More... | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. More... | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. More... | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. More... | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. More... | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. More... | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More... | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. More... | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More... | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. More... | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. More... | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. More... | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. More... | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. More... | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. More... | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More... | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. More... | |
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::vector< DtFilename > | SearchPaths |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (std::string &fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static void | setPutIndent (bool) |
| static bool | putIndent () |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. More... | |
| static const DtFilename & | appPath () |
| Gets the current working directory. More... | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. More... | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static void | setOutputStream (DtOutputStream *stream) |
| static DtOutputStream & | outputStream () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. More... | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. More... | |
| Protected Member Functions inherited from DtSimBlock | |
| virtual void | cloneListFrom (const DtSimBlock &other) |
| This function will clone the statements from the given statement list. More... | |
| Protected Member Functions inherited from DtRwIntrusiveList | |
| DtRwIntrusiveList (const DtRwIntrusiveList &orig) | |
| C++ copy constructor Not implemented, do not call. More... | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. More... | |
| Protected Attributes inherited from DtSimBlock | |
| DtSimStatement * | myParentStatement |
| Protected Attributes inherited from DtRwIntrusiveList | |
| DtList | myList |
| The actual DtList used to store the items. More... | |
| Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| DtReaderWriterRegistry * | myParentRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| DtReaderWriter * | myDefaultValue |
| aliasContainer | myAliases |
| Container for the aliases which represent alternative names for the object. More... | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. More... | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. More... | |
| Static Protected Attributes inherited from DtReaderWriter | |
| static DtString | theUnspecifiedValue |
| static DtGetSelfCallbackInfo | thePostGetSelfCallback |
| static DtPutSelfCallbackInfo | thePrePutSelfCallback |
| static const DtVariableBindingsList | theEmptyVariableBindingsList |
| static bool | theCreatorFcnSet |
| static DtReaderWriterFactory * | theFactory |
| static DtReaderWriterFactoryCreatorFcn | theFactoryCreatorFcn |
| static bool | thePutIndent |
| static DtOutputStream * | theOutputStream |
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 |
Get this block's while statement.
|
virtual |
Get this block's while statement.