 |
VR-Forces 4.1 Class Documentation
|
|
VR-Forces 4.1 Class Documentation
|
This is the generic B-HAVE Task. More...
Public Member Functions | |
| DtBhaveTask () | |
| default constructor | |
| DtBhaveTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| virtual | ~DtBhaveTask () |
| Destructor. | |
| DtBhaveTask (const DtString &writeName, const DtBhaveTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| Copy constructor. | |
| DtBhaveTask & | operator= (const DtBhaveTask &orig) |
| Assignment operator. | |
| virtual const DtSimTaskMessageType & | type () const |
| Returns "user-defined-task". | |
| virtual DtSimTask * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of this user-defined task. | |
| virtual DtString | stringRep () const |
| Returns a human-readable string representation of the task. | |
 Public Member Functions inherited from DtUserTask | |
| DtUserTask () | |
| default constructor | |
| DtUserTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| virtual | ~DtUserTask () |
| destructor | |
| DtUserTask (const DtString &writeName, const DtUserTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtUserTask & | operator= (const DtUserTask &orig) |
| assignment operator | |
| virtual const DtString & | userTaskName () const |
| Set/get the name of the user-defined task. | |
| virtual void | setUserTaskName (const DtString &taskName) |
| virtual const DtString & | arg1Text () const |
| Set/get the 1st argument. | |
| virtual void | setArg1Text (const DtString &value) |
| virtual const DtString & | arg2Text () const |
| Set/get the 2nd argument. | |
| virtual void | setArg2Text (const DtString &value) |
| virtual const DtString & | arg3Text () const |
| Set/get the 3rd argument. | |
| virtual void | setArg3Text (const DtString &value) |
| virtual const DtString & | arg4Text () const |
| Set/get the 4th argument. | |
| virtual void | setArg4Text (const DtString &value) |
| 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 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 | |
| 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 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 |
| 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 DtUserTask | |
| DtRwString | myUserTaskName |
| DtRwString | myArg1Text |
| DtRwString | myArg2Text |
| DtRwString | myArg3Text |
| DtRwString | myArg4Text |
| Static Protected Attributes inherited from DtSimTask | |
| static DtSimTaskFactory * | myFactory |
This is the generic B-HAVE Task.
It wraps the DtUserTask, but the userTaskName is automatically set to "kynapse-task", and is not included in the string-rep.
For all B-HAVE tasks, arg1 must be set to the task name definition above. For each task type, the other arguments vary, as specified here: Flee: Arg2: Radius (in meters) to flee from the targets. Arg3: "1" for Stop When Hidden, otherwise "0". Arg4: Comma separated list of object names to flee from.
Hide: Arg4: Comma separated list of object names to hide from.
Wander: Arg2: Time to wander in seconds. "-1" indicated no endtime. Arg3: Area name to restrict wandering to, if any.
Move To Waypoint: Arg2: Name of waypoint to move to.
Move To Location: Arg2: Location to move to. This is specified in geocentric, as three floats separated by spaces.
Move Along Route: Arg2: Name of route.. Arg3: Indicates direction of movement, either "reverse" or "normal".
| BHAVE::DtBhaveTask::DtBhaveTask | ( | ) |
default constructor
| BHAVE::DtBhaveTask::DtBhaveTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
|
virtual |
Destructor.
| BHAVE::DtBhaveTask::DtBhaveTask | ( | const DtString & | writeName, |
| const DtBhaveTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
Copy constructor.
| DtBhaveTask& BHAVE::DtBhaveTask::operator= | ( | const DtBhaveTask & | orig | ) |
Assignment operator.
|
virtual |
Returns "user-defined-task".
Reimplemented from DtUserTask.
|
virtual |
Creates a copy of this user-defined task.
Reimplemented from DtUserTask.
|
virtual |
Returns a human-readable string representation of the task.
This string representation is used to display information about the task in the plan editor and viewer. The type and parameters for the task are typically encoded in the string. The format of the string is up to you.
Reimplemented from DtUserTask.
|
static |
Reimplemented from DtUserTask.