 |
VR-Forces 4.3.1 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces 4.3.1 Class Documentation
|
DtFollowEntityTask represents a follow entity task for an entity to perform. More...
Public Member Functions | |
| DtFollowEntityTask () | |
| default constructor | |
| DtFollowEntityTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtFollowEntityTask (const DtString &writeName, const DtFollowEntityTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| Copy constructor; nothing to be copied. | |
| const DtFollowEntityTask & | operator= (const DtFollowEntityTask &orig) |
| assignment operator | |
| virtual | ~DtFollowEntityTask () |
| virtual const DtSimTaskMessageType & | type () const |
| Returns DtFollowEntityType. | |
| virtual DtSimTask * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of this follow entity task. | |
| virtual DtString | stringRep () const |
| Get a readable string representation of this task. | |
| virtual const DtString & | entityToFollow () const |
| Object name of the entity to follow. | |
| virtual void | setEntityToFollow (const DtString &entity) |
| virtual const DtVector & | offsetVector () const |
| Set/get the offset of the entity from the entity it is following. | |
| virtual void | setOffsetVector (const DtVector &offsets) |
| virtual int | netRepSize () const |
| Returns the size of the full network representation padded to an 8-byte boundary. | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Fills in the task from the network buffer. | |
| virtual bool | setToNet () |
| Fills in the network buffer (created by base class simTask) with the task contents. | |
 Public Member Functions inherited from DtSimTask | |
| virtual | ~DtSimTask () |
| destructor | |
| 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. | |
| virtual bool | isTypeRegistered (const DtSimTaskMessageType &taskName) |
| virtual void | setSubtask (bool flag) |
| If true, this task is a subtask. | |
| virtual bool | subtask () const |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. | |
| 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 actually stored. | |
| virtual char * | netRep () |
| 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 (FILE *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 (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 void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to iriginal 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 * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| 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 DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
| 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 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) |
| The variable name, if this object is a variable reference. | |
| 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 () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| 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 () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| 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 &) |
| Restires 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. | |
Static Public Member Functions | |
| static DtSimTask * | creator () |
| Static Public Member Functions inherited from DtSimTask | |
| static DtSimTask * | createTask (DtlObjPtr mtlStream) |
| Static functions. | |
| static DtSimTask * | createTask (const DtSimTaskMessageType &taskType) |
| static void | addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn) |
| Adds a task creator member function to the task factory. | |
| static void | setFactory (DtSimTaskFactory *factory) |
| static DtSimTaskFactory * | factory () |
| 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 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 DtReaderWriter * | createFromXmlFile (const DtFilename &) |
| Given a filename, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromXml (const DtString &) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP) |
| 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. | |
| Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| static DtObjectCounter::CounterType | ObjectCount () |
| static const DtObjectContainer * | ObjectContainer () |
Protected Attributes | |
| DtRwString | myEntityToFollow |
| DtRwOffsetVector | myOffsetVector |
| Specialized vector that knows it is an offset, not a world location. | |
| Protected Attributes inherited from DtSimTask | |
| DtRwBoolean | mySubtask |
| 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. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
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 DtSimTask | |
| DtSimTask () | |
| Constructors are protected because no one should instantiate the base class, just derived versions. | |
| DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the write name will preface the task. | |
| DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimTask & | operator= (const DtSimTask &orig) |
| assignment operator; same as copy constructor | |
| virtual char * | createNetworkBuffer () |
| Static Protected Attributes inherited from DtSimTask | |
| static DtSimTaskFactory * | myFactory |
DtFollowEntityTask represents a follow entity task for an entity to perform.
It inherits read/writableness from SimTask, and includes the entity to follow, and the offset from the entity. This offset is expressed in body coordinates (x out the front, y to the right, z down). z is ignored for ground vehicles. Therefore, to have a ground vehicle follow another entity 20m behind and 5m to the right, the offset vector would be (-20., 5., 0.)
If the entity to follow does not exist, the following entity stops. If at some later point during the simulation, the entity-to-follow comes into existence, then the entity starts following it. If the entity being followed gets destroyed, the following entity stops and sends a taskComplete(), indicating that it is finished executing the task and is ready for a new task.
An entity executing a DtFollowEntityTask will not advance to another task unless one of the following things happens:
task-type: DtFollowEntityType
parameters: entity to follow - Echelon ID string (object name) of the entity to be followed.
offset vector - Following offset expressed in body coordinates, rela- tive to the entity to be followed. In body coordinates, the X-axis points out the front of the entity, the Y-axis points to the right, and Z- axis points down. Units are in meters. For example, if the entity was tasked to follow 25 m behind the entity, and 5 m to the right, then the offset vector would be <-25.0, 5.0, 0.0>.
| DtFollowEntityTask::DtFollowEntityTask | ( | ) |
default constructor
| DtFollowEntityTask::DtFollowEntityTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtFollowEntityTask::DtFollowEntityTask | ( | const DtString & | writeName, |
| const DtFollowEntityTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
Copy constructor; nothing to be copied.
Here to thwart over-ambitious compilers that create one when it shouldn't.
|
virtual |
| const DtFollowEntityTask& DtFollowEntityTask::operator= | ( | const DtFollowEntityTask & | orig | ) |
assignment operator
|
virtual |
Returns DtFollowEntityType.
Implements DtSimTask.
|
virtual |
Creates a copy of this follow entity task.
Implements DtSimTask.
|
virtual |
Get a readable string representation of this task.
Implements DtSimTask.
|
virtual |
Object name of the entity to follow.
|
virtual |
|
virtual |
Set/get the offset of the entity from the entity it is following.
|
virtual |
|
virtual |
Returns the size of the full network representation padded to an 8-byte boundary.
Reimplemented from DtSimTask.
|
virtual |
Fills in the task from the network buffer.
Reimplemented from DtSimTask.
|
virtual |
Fills in the network buffer (created by base class simTask) with the task contents.
Reimplemented from DtSimTask.
|
static |
|
protected |
|
protected |
Specialized vector that knows it is an offset, not a world location.