Public Member Functions |
| | DtRailPathTask () |
| | default constructor
|
| | DtRailPathTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) |
| | constructor If you have a task 'put' itself, the writeName will preface the task.
|
| | DtRailPathTask (const DtString &writeName, const DtRailPathTask &orig, DtReaderWriterRegistry *parentRegistry=0) |
| | copy constructor
|
| const DtRailPathTask & | operator= (const DtRailPathTask &orig) |
| | assignment operator
|
| virtual | ~DtRailPathTask () |
virtual const
DtSimTaskMessageType & | type () const |
| | Returns "rail-path-task".
|
| 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.
|
| virtual void | setDestinationNameSpecified (bool specified) |
| virtual bool | destinationNameSpecified () const |
| virtual void | setDestinationName (const DtString &name) |
| virtual const DtString & | destinationName () const |
| virtual void | setDestination (const DtVector &destination) |
| virtual const DtVector & | destination () const |
| virtual void | setDestinationIsRoute (bool route) |
| virtual bool | destinationIsRoute () const |
| virtual void | setTraversalDirection (DtIteratorDirection traversalDirection) |
| | [DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false.
|
| virtual DtIteratorDirection | traversalDirection () const |
| virtual void | setStartAtClosestPoint (bool startAtClosestPoint) |
| | Flag indicating whether traversal should start at the beginning of route or at the closest point (which may be somewhere along the route).
|
| virtual bool | startAtClosestPoint () const |
| virtual int | netRepSize () const |
| | Returns the size in bytes of the network representation of the class.
|
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| | Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
|
| virtual bool | setToNet () |
| | Calls netRep() to create the network buffer.
|
| 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 () |
| | 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.
|
File: railPathTask.h.
Class: DtRailPathTask DtRailPathTask represents a railPath task for an entity to perform. It inherits DtPathTask and has all the same parameters as that task.
This task can be used by any vehicle having a rail 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. The entity while on the path will switch to the rails movement system which locks the entity on to the path and optionally provide smooth turning around corners.
task-type: DtRailPathType
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.
Public Member Functions inherited from DtSimTask