 |
VR-Forces 4.6 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.6 Class Documentation
|
class DtPlanBlock: More...
Public Member Functions | |
| DtPlanBlock (DtPlan *plan=NULL) | |
| default constructor | |
| DtPlanBlock (const DtString &name, DtPlan *plan=NULL, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtPlanBlock (const DtPlanBlock &orig) | |
| default copy constructor NOTE: this does a deep copy of the statements. | |
| DtPlanBlock (const DtString &name, const DtPlanBlock &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| better copy constructor NOTE: this does a deep copy of the statements. | |
| virtual | ~DtPlanBlock () |
| destructor | |
| DtPlanBlock & | operator= (const DtPlanBlock &orig) |
| assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones. | |
| virtual DtSimBlock * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const |
| The normal clone function. | |
| virtual DtPlan * | plan () const |
| Get a pointer to the parent plan. | |
| virtual void | setPlan (DtPlan *arg) |
| Set the pointer to the parent plan. | |
| virtual void | exitFromBlock (DtPlan &planContext) |
| This function is called by the last statement in the block so that the block can do whatever is appropriate at the end of this block. | |
| 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. | |
 Public Member Functions inherited from DtSimBlock | |
| DtSimBlock (DtSimStatement *parentStatement) | |
| default constructor | |
| DtSimBlock (const DtString &name, DtSimStatement *parentStatement, 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 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. | |
| 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. | |
| 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. | |
| void | setParentStatement (DtSimStatement *) |
| Sets the parent statement of this block. | |
| DtSimStatement * | parentStatement () const |
| Returns parent statement of this block. | |
| virtual DtListItem * | addToList (DtRwListedObj *data, DtRwListedObj *after) |
| Add element to the list just after the indicated item. | |
| virtual void | upgradeTriggerUUID (const boost::unordered_map< DtUUID, DtUUID > &) |
| For those statements that need to, map from the old to new trigger UUID. | |
| 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 DtReaderWriter::SearchPaths &searchPaths, 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) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| 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. | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| 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. | |
| 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 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. | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| 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 const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| 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 bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| 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. | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| 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 void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| 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. | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| 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. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| 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. | |
| 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. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
Protected Attributes | |
| DtPlan * | myPlan |
| Protected Attributes inherited from DtSimBlock | |
| DtSimStatement * | myParentStatement |
| Protected Attributes inherited from DtRwIntrusiveList | |
| DtList | myList |
| The actual DtList used to store the items. | |
| 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. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. | |
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. | |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. | |
| Protected Member Functions inherited from DtSimBlock | |
| 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 bool | theCreatorFcnSet |
| static DtReaderWriterFactory * | theFactory |
| static DtReaderWriterFactoryCreatorFcn | theFactoryCreatorFcn |
| static bool | thePutIndent |
class DtPlanBlock:
Instances of DtPlanBlock represent top-level blocks of statements in Plans.
| DtPlanBlock::DtPlanBlock | ( | DtPlan * | plan = NULL | ) |
default constructor
| DtPlanBlock::DtPlanBlock | ( | const DtString & | name, |
| DtPlan * | plan = NULL, |
||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
real constructor
| DtPlanBlock::DtPlanBlock | ( | const DtPlanBlock & | orig | ) |
default copy constructor NOTE: this does a deep copy of the statements.
| DtPlanBlock::DtPlanBlock | ( | const DtString & | name, |
| const DtPlanBlock & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
better copy constructor NOTE: this does a deep copy of the statements.
|
virtual |
destructor
| DtPlanBlock& DtPlanBlock::operator= | ( | const DtPlanBlock & | orig | ) |
assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones.
|
virtual |
The normal clone function.
Implements DtSimBlock.
|
virtual |
Get a pointer to the parent plan.
|
virtual |
Set the pointer to the parent plan.
|
virtual |
This function is called by the last statement in the block so that the block can do whatever is appropriate at the end of this block.
For Plan blocks, this will Complete the parent DtPlan.
Implements DtSimBlock.
|
virtual |
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.
Returns true if a match was found, false otherwise.
Reimplemented from DtSimBlock.
|
protected |