 |
VR-Forces 4.8 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.8 Class Documentation
|
Set version of scripted task that is used in scripted set scripts. More...
Public Member Functions | |
| DtScriptedTaskSet () | |
| default constructor More... | |
| DtScriptedTaskSet (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. More... | |
| DtScriptedTaskSet (const DtString &writeName, const DtScriptedTaskSet &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| DtScriptedTaskSet (const DtScriptedTaskSet &orig) | |
| copy constructor More... | |
| const DtScriptedTaskSet & | operator= (const DtScriptedTaskSet &orig) |
| assignment operator More... | |
| virtual | ~DtScriptedTaskSet () |
| virtual const DtSetMessageType & | type () const |
| Returns scriptId. More... | |
| virtual DtSetDataRequest * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of this convoy task. More... | |
 Public Member Functions inherited from DtScriptedTaskTemplate< DtSetDataRequest > | |
| DtScriptedTaskTemplate () | |
| default constructor More... | |
| DtScriptedTaskTemplate (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. More... | |
| DtScriptedTaskTemplate (const DtString &writeName, const DtScriptedTaskTemplate &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| DtScriptedTaskTemplate (const DtScriptedTaskTemplate &orig) | |
| copy constructor More... | |
| const DtScriptedTaskTemplate & | operator= (const DtScriptedTaskTemplate &orig) |
| assignment operator More... | |
| virtual | ~DtScriptedTaskTemplate () |
| virtual DtString | stringRep () const |
| Get a readable string representation of this task. More... | |
| virtual DtString | allVariablesStringRep (const DtString &scriptName="") const |
| Returns all the variables in a single string. More... | |
| virtual int | netRepSize () const |
| Returns the size of the full network representation (control object name included) padded to an 8-byte boundary. More... | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Fills in the task from the network buffer. More... | |
| virtual bool | init () |
| Initializer. More... | |
| virtual bool | setToNet () |
| Fills in the network buffer (created by base class simTask) with the task contents. More... | |
| virtual char * | setToNet (char *) |
| virtual DtRwVariableBindings & | variables () |
| Access to variables. More... | |
| virtual const DtRwVariableBindings & | variables () const |
| virtual void | setVariables (const DtRwVariableBindings &) |
| virtual DtRwVariableBindings & | variableDataTypes () |
| Access to the data types that represent the variables. More... | |
| virtual const DtRwVariableBindings & | variableDataTypes () const |
| virtual void | setScriptId (const DtString &) |
| Script to run. More... | |
| virtual const DtString & | scriptId () const |
| Script id. More... | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference()) |
| Override to upgrade scripted objects from nlength string list to nlength uuid list. More... | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Public Member Functions inherited from DtSetDataRequest | |
| virtual | ~DtSetDataRequest () |
| destructor More... | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. More... | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actual stored. More... | |
| virtual char * | netRep () |
| 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 void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More... | |
| 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 * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. 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 | 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 | 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... | |
| Public Member Functions inherited from DtScriptedTask | |
| DtScriptedTask () | |
| virtual | ~DtScriptedTask () |
| virtual void | setValue (const DtString &variableName, bool, const char *type=DtScriptedTaskCheckBoxVariable) |
| {@ Convenience methods that will allow for the adding and retrieving values that are valid for this scripted task More... | |
| virtual void | setValue (const DtString &variableName, int, const char *type=DtScriptedTaskIntegerVariable) |
| virtual void | setValue (const DtString &variableName, double, const char *type=DtScriptedTaskDoubleVariable) |
| virtual void | setValue (const DtString &variableName, const std::string &, const char *type=DtScriptedTaskStringVariable) |
| virtual void | setValue (const DtString &variableName, const DtString &, const char *type=DtScriptedTaskStringVariable) |
| virtual void | setValue (const DtString &variableName, const char *, const char *type=DtScriptedTaskStringVariable) |
| virtual void | setValue (const DtString &variableName, const DtUUID &, const char *type=DtScriptedTaskSimulationObjectVariable) |
| virtual void | setValue (const DtString &variableName, const DtVector &, const char *type=DtScriptedTaskLocationVariable) |
| virtual void | setValue (const DtString &variableName, const DtEntityType &, const char *type=DtScriptedTaskEntityTypeVariable) |
| virtual void | setValue (const DtString &variableName, const DtTaitBryan &, const char *type=DtScriptedTaskOrientationVariable) |
| virtual void | setValue (const DtString &variableName, const DtRwOffsetVectorList &) |
| virtual void | setValue (const DtString &variableName, const DtRwVectorList &) |
| virtual void | setValue (const DtString &variableName, const std::vector< DtUUID > &) |
| virtual void | setValue (const DtString &variableName, const std::vector< DtVector > &) |
| virtual void | setValue (const DtString &variableName, const std::map< DtString, int > &) |
| virtual void | setValue (const DtString &variableName, const std::map< DtString, double > &) |
| virtual void | setValue (const DtString &variableName, const std::map< DtString, DtString > &) |
| virtual void | setLocation (const DtString &variableName, const DtVector &) |
| Since there are multiple types that take a vector, overload with different types that will be set. More... | |
| virtual void | setLocationWithoutAltitude (const DtString &variableName, const DtVector &) |
| virtual void | setOffset (const DtString &variableName, const DtRwOffsetVector &) |
| virtual void | setTime (const DtString &variableName, double) |
| virtual void | setDateTime (const DtString &variableName, double) |
| virtual void | setRange (const DtString &variableName, double) |
| virtual void | setAltitude (const DtString &variableName, double) |
| virtual void | setHeading (const DtString &variableName, double) |
| virtual void | setPitch (const DtString &variableName, double) |
| virtual void | setValue (const DtString &variableName, const DtReaderWriter &, const char *scriptedTaskType) |
| The reader/writer value will be cloned and added to the variables with the given variable name and the scripted task variable type (see vrfScriptedTaskConstants.h) More... | |
| template<typename RWValue , typename AssignType > | |
| void | setValue (const DtString &variableName, AssignType value, const char *type) |
| General template assignment that will create a new instance of a reader/writer and assign a value to it. More... | |
| template<typename T > | |
| boost::optional< T > | getValue (const DtString &variableName) const |
| virtual const DtReaderWriter * | getValueRW (const DtString &name) const |
| Returns the base reader/writer value. More... | |
| virtual DtReaderWriter * | getValueRW (const DtString &name) |
Static Public Member Functions | |
| static DtSetDataRequest * | creator () |
| Static Public Member Functions inherited from DtSetDataRequest | |
| static DtSetDataRequest * | createSetDataRequest (DtlObjPtr mtlStream) |
| Static functions. More... | |
| static DtSetDataRequest * | createSetDataRequest (DtSetMessageType requestType) |
| static void | addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn) |
| static void | setFactory (DtSetDataRequestFactory *factory) |
| static DtSetDataRequestFactory * | factory () |
| static bool | isTypeRegistered (DtSetMessageType setDataType) |
| 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 Member Functions inherited from DtScriptedTask | |
| static void | setScriptedTaskFormatter (ScriptedTaskFormatter *) |
| static ScriptedTaskFormatter * | scriptedTaskFormatter () |
Protected Attributes | |
| DtSetMessageType | myType |
| Protected Attributes inherited from DtScriptedTaskTemplate< DtSetDataRequest > | |
| DtRwString | myScriptId |
| DtRwVariableBindings | myVariables |
| DtRwVariableBindings | myVariableDataTypes |
| Protected Attributes inherited from DtSetDataRequest | |
| char * | myNetRep |
| 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... | |
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 )() |
| Protected Member Functions inherited from DtScriptedTaskTemplate< DtSetDataRequest > | |
| virtual void | upgradeVariables () |
| Protected Member Functions inherited from DtSetDataRequest | |
| DtSetDataRequest () | |
| Constructors are protected because no one should instantiate the base class, just derived versions. More... | |
| DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a request 'put' itself, the write name will preface it. More... | |
| DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| const DtSetDataRequest & | operator= (const DtSetDataRequest &orig) |
| assignment operator; same as copy costructor. More... | |
| virtual char * | createNetworkBuffer () |
| int setDataType); More... | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. More... | |
| Static Protected Attributes inherited from DtSetDataRequest | |
| static DtSetDataRequestFactory * | myFactory |
| 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 |
| Static Protected Attributes inherited from DtScriptedTask | |
| static ScriptedTaskFormatter * | theScriptedTaskFormatter |
Set version of scripted task that is used in scripted set scripts.
| DtScriptedTaskSet::DtScriptedTaskSet | ( | ) |
default constructor
| DtScriptedTaskSet::DtScriptedTaskSet | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtScriptedTaskSet::DtScriptedTaskSet | ( | const DtString & | writeName, |
| const DtScriptedTaskSet & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| DtScriptedTaskSet::DtScriptedTaskSet | ( | const DtScriptedTaskSet & | orig | ) |
copy constructor
|
virtual |
| const DtScriptedTaskSet& DtScriptedTaskSet::operator= | ( | const DtScriptedTaskSet & | orig | ) |
assignment operator
|
virtual |
Returns scriptId.
Implements DtSetDataRequest.
|
virtual |
Creates a copy of this convoy task.
Implements DtSetDataRequest.
|
static |
|
mutableprotected |