 |
VR-Forces 4.2 Class Documentation
|
|
VR-Forces 4.2 Class Documentation
|
File: planAndMoveToTask.h. More...
Public Member Functions | |
| DtPlanAndMoveToTask () | |
| default constructor | |
| DtPlanAndMoveToTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtPlanAndMoveToTask (const DtString &writeName, const DtPlanAndMoveToTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtPlanAndMoveToTask & | operator= (const DtPlanAndMoveToTask &orig) |
| assignment operator | |
| virtual | ~DtPlanAndMoveToTask () |
| virtual const DtSimTaskMessageType & | type () const |
| Returns "plan-and-move-to". | |
| virtual DtSimTask * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of this task. | |
| virtual DtString | stringRep () const |
| Get a readable string representation of this task. | |
 Public Member Functions inherited from DtMoveToTask | |
| DtMoveToTask () | |
| default constructor | |
| DtMoveToTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtMoveToTask (const DtString &writeName, const DtMoveToTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtMoveToTask & | operator= (const DtMoveToTask &orig) |
| assignment operator | |
| virtual | ~DtMoveToTask () |
| virtual const DtString & | controlPtName () const |
| virtual void | setControlPtName (const DtString &cpName) |
| virtual void | setContinueFlag (bool flag) |
| Give the user the option to not slow down on approach of the control point. | |
| virtual bool | continueFlag () const |
| virtual int | netRepSize () const |
| Returns the size of the full network representation (control object name included) 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 DtFilename &searchPath, 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) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| 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 | getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| 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 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 DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| 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 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. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Static Public Member Functions | |
| static DtSimTask * | creator () |
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::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 () |
| Protected Attributes inherited from DtMoveToTask | |
| DtRwObjectName | myControlPtName |
| DtRwBoolean | myContinueFlag |
| Static Protected Attributes inherited from DtSimTask | |
| static DtSimTaskFactory * | myFactory |
File: planAndMoveToTask.h.
Class: DtPlanAndMoveToTask DtPlanAndMoveToTask represents a planAndMoveTo task for an entity to perform. It inherits DtMoveToTask and has all the same parameters as that task.
This task can be used by any vehicle having a path planning controller. It indicates that the vehicle should plan a path to the specified object, and then move along that path to the object.
task-type: DtPlanAndMoveToType
parameters: control point name - The string name of the control point to move toward. You can look up the DtVrfObject corresponding to this name in the Object Manager.
| DtPlanAndMoveToTask::DtPlanAndMoveToTask | ( | ) |
default constructor
| DtPlanAndMoveToTask::DtPlanAndMoveToTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtPlanAndMoveToTask::DtPlanAndMoveToTask | ( | const DtString & | writeName, |
| const DtPlanAndMoveToTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
| const DtPlanAndMoveToTask& DtPlanAndMoveToTask::operator= | ( | const DtPlanAndMoveToTask & | orig | ) |
assignment operator
|
virtual |
Returns "plan-and-move-to".
Reimplemented from DtMoveToTask.
|
virtual |
Creates a copy of this task.
Reimplemented from DtMoveToTask.
|
virtual |
Get a readable string representation of this task.
Reimplemented from DtMoveToTask.
|
static |
Reimplemented from DtMoveToTask.