 |
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 DtSimConditionalStatement: More...
Public Member Functions | |
| DtSimConditionalStatement (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| default constructor More... | |
| DtSimConditionalStatement (const DtSimConditionalStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| virtual | ~DtSimConditionalStatement () |
| destructor More... | |
| virtual const DtSimCondExpr * | condExpr () const =0 |
| Returns the conditional expression used to evaluate the wait until. More... | |
| virtual void | setCondExpr (const DtSimCondExpr *arg)=0 |
| Sets the conditional expression used to evaluate the wait until. More... | |
 Public Member Functions inherited from DtSimStatement | |
| DtSimStatement () | |
| Default constructor. More... | |
| DtSimStatement (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Usual constructor NOTE: "name" should be the statement type string. More... | |
| DtSimStatement (const DtSimStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Copy constructor. More... | |
| virtual | ~DtSimStatement () |
| Destructor. More... | |
| virtual bool | init () |
| Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation. More... | |
| DtSimStatement & | operator= (const DtSimStatement &orig) |
| Assignment operator (protected because this is an abstract base class). More... | |
| virtual DtSimStatement * | clone (DtReaderWriterRegistry *parentRegistry=NULL) const =0 |
| virtual copy constructor A typical clone function. More... | |
| virtual int | type () const =0 |
| Returns the type of statement Type (defined in simStmtTypes.h) More... | |
| virtual bool | validate () |
| Checks the statement for validity, and potentially fixes the statement to be valid. More... | |
| virtual void | execute (DtPlan &planContext)=0 |
| Execute the current statement and make any changes to the Plan state as appropriate. More... | |
| virtual void | step (DtPlan &planContext, bool forceStep=false) |
| Asks the statement to step the context DtPlan to the next statement. More... | |
| DtSimStatement * | nextStmt () const |
| Return next (previous) statements in the block, or NULL if hit the end (beginning) of the list. More... | |
| DtSimStatement * | prevStmt () const |
| virtual DtStmtIdType | statementId () const |
| Statement Id accessors. More... | |
| virtual void | setStatementId (DtStmtIdType arg) |
| virtual DtSimBlock * | parentBlock () const |
| The parent statement Block. More... | |
| virtual void | setParentBlock (DtSimBlock *arg) |
| virtual int | subBlockCount () const |
| Get the number of blocks nested inside this statement. More... | |
| virtual DtSimBlock * | subBlock (int index) |
| Get a pointer to any particular block nested inside this statement. More... | |
| virtual DtRecursiveSimStatementIterator * | spawnRecursiveIterator () const |
| Spawns an iterator that iterates over the subblocks in this statement, and all their children, sub children, etc. More... | |
| virtual DtSimStatement * | lookupStatement (DtStmtIdType statementId) |
| If statementId matches our statement, returns a pointer to us. More... | |
| virtual void | setStatementDescription (const DtString &) |
| If supported for display a description of this statement that can be used for display. More... | |
| virtual const DtString & | statementDescription () const |
| virtual DtString | stringRep (int subBlockIndex=DtSR_STMT) const =0 |
| Get a readable string representation of this statement. More... | |
| virtual char * | netRep () |
| virtual int | netRepSize () const |
| Returns sizeof(DtNetSimStatement). More... | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Extracts statement Id from buffer. More... | |
| virtual bool | setToNet () |
| Casts myNetRep to DtNetSimStatement* and fills in structure. More... | |
| virtual bool | isSameStatement (DtSimStatement *) |
| Returns true if statements are equivalent. Will not check statementId. 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 DtRwListedObj | |
| DtRwListedObj () | |
| Default constructor. More... | |
| DtRwListedObj (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Real constructor. More... | |
| DtRwListedObj (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwListedObj (const DtRwListedObj &orig) | |
| Copy constructor. More... | |
| virtual | ~DtRwListedObj () |
| Destructor. More... | |
| DtRwListedObj & | operator= (const DtRwListedObj &orig) |
| Assignment operator. More... | |
| DtRwListedObj * | next () const |
| Return next (previous) elements on the list, or NULL if hit the end (beginning) of the list. More... | |
| DtRwListedObj * | prev () const |
| DtRwListedObj * | wrapNext () const |
| Return next (previous) elements on the list, but wrap to the beginning (end) of the list when you hit the end (beginning). More... | |
| DtRwListedObj * | wrapPrev () const |
| 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 | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. 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 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. 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 DtSimStatement | |
| static DtStmtIdType | generateNewStmtId () |
| static DtSimStatement * | createStatement (DtlObjPtr mtlStream, DtReaderWriterRegistry *parentRegistry=NULL) |
| Static functions. More... | |
| static DtSimStatement * | createStatement (int statementType, DtReaderWriterRegistry *parentRegistry=NULL) |
| static void | addStatementCreatorFcn (const DtString &type, int intType, DtStatementCreatorFcn fcn) |
| Decodes a legacy stealth statement (VRF 3.9 and previous) and returns the proper statement for the current version. More... | |
| static void | setFactory (DtStatementFactory *factory) |
| static DtStatementFactory * | factory () |
| static bool | getStatementNameFromStatementType (int statementType, DtString &statementName) |
| static bool | getStatementTypeFromStatementName (const DtString &statementName, int &statementType) |
| static bool | addStatementTypeMapping (const DtString &statementName, int taskType) |
| static bool | removeStatementTypeMapping (const DtString &statementName, int statementType) |
| 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... | |
| Static Public Attributes inherited from DtSimStatement | |
| static const int | DtSR_STMT = -1 |
| A constant for use as the subBlockIndex argument to stringRep(). More... | |
| Protected Member Functions inherited from DtSimStatement | |
| virtual char * | createNetworkBuffer () |
| virtual bool | compare (DtSimStatement *) |
| Called from isSameStatement. More... | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. More... | |
| Protected Attributes inherited from DtSimStatement | |
| DtStmtIdType | myStatementId |
| A semi-unique Id value that helps trace the original identity of this statement if/when it gets copied. More... | |
| DtSimBlock * | myParentBlock |
| The containing DtSimBlock object (if any). More... | |
| char * | myNetRep |
| DtRwString | myStatementDescription |
| Protected Attributes inherited from DtRwListedObj | |
| DtList * | myList |
| DtListItem * | myItem |
| 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 DtSimStatement | |
| static DtStatementFactory * | myFactory |
| Factory for this class. More... | |
| static DtStringIntMapper | theStatementNameMapper |
| 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 DtSimConditionalStatement:
Base class that conditional statements subclass from to indicate they are conditional statemnts.
|
inline |
default constructor
|
inline |
copy constructor
|
inlinevirtual |
destructor
|
pure virtual |
Returns the conditional expression used to evaluate the wait until.
Implemented in DtTriggerStmt, DtIfStmt, DtDoUntilStmt, DtWhileStmt, and DtWaitUntilStmt.
|
pure virtual |
Sets the conditional expression used to evaluate the wait until.
Implemented in DtTriggerStmt, DtIfStmt, DtDoUntilStmt, DtWhileStmt, and DtWaitUntilStmt.