 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
DtMoveAlongTask represents a Move Along Route task for an entity to perform. More...
Public Member Functions | |
| DtMoveAlongTask () | |
| default constructor | |
| DtMoveAlongTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtMoveAlongTask (const DtString &writeName, const DtMoveAlongTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtMoveAlongTask & | operator= (const DtMoveAlongTask &orig) |
| assignment operator | |
| virtual | ~DtMoveAlongTask () |
| virtual int | type () const |
| Returns "move-along". | |
| virtual DtSimTask * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of this move-along task. | |
| virtual DtString | stringRep () const |
| Get a readable string representation of this task. | |
| virtual const DtString & | routeName () const |
| The string name of the route to be followed. | |
| virtual void | setRouteName (const DtString &rteName) |
| 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 |
| Rreturns 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. | |
Static Public Member Functions | |
| static DtSimTask * | creator () |
Protected Attributes | |
| DtRwString | myRouteName |
| DtRwInt | myTraversalDirection |
| DtRwBoolean | myStartAtClosestPoint |
DtMoveAlongTask represents a Move Along Route task for an entity to perform.
It inherits read/writableness from SimTask, and includes the control point to move to. The string name of the route is specified as a parameter of the task. The route name refers to a DtVrfObject. A route is a control object that contains an ordered list of vertices that represent a path for the entity to follow. Entities that implement this task move to the first vertex, then move successively from one vertex to the next. The task is considered complete when the entity reaches the last vertex in the route.
Both individual and pseudo-aggregate entities implement this task. A pseudo-aggregate entity forwards the move-along task to its lead subordinate. All other subordinates in the pseudo-aggregate are tasked to follow in formation. The pseudo-aggregate considers the Move Along task complete for the pseudo-aggregate as a whole when its lead subordinate completes the task
task-type: DtMoveAlongType
parameters: route name - The string name of the route to be followed. To find the DtRoute object to which the name refers look up the name in the Object Manager.
default constructor
| DtMoveAlongTask::DtMoveAlongTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtMoveAlongTask::DtMoveAlongTask | ( | const DtString & | writeName, |
| const DtMoveAlongTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtMoveAlongTask::~DtMoveAlongTask | ( | ) | [virtual] |
| const DtMoveAlongTask& DtMoveAlongTask::operator= | ( | const DtMoveAlongTask & | orig | ) |
assignment operator
| virtual int DtMoveAlongTask::type | ( | ) | const [virtual] |
Returns "move-along".
Implements DtSimTask.
| virtual DtSimTask* DtMoveAlongTask::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
Creates a copy of this move-along task.
Implements DtSimTask.
| virtual DtString DtMoveAlongTask::stringRep | ( | ) | const [virtual] |
Get a readable string representation of this task.
Implements DtSimTask.
| virtual const DtString& DtMoveAlongTask::routeName | ( | ) | const [virtual] |
The string name of the route to be followed.
| virtual void DtMoveAlongTask::setRouteName | ( | const DtString & | rteName | ) | [virtual] |
| virtual void DtMoveAlongTask::setTraversalDirection | ( | DtIteratorDirection | traversalDirection | ) | [virtual] |
[DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false.
| virtual DtIteratorDirection DtMoveAlongTask::traversalDirection | ( | ) | const [virtual] |
| virtual void DtMoveAlongTask::setStartAtClosestPoint | ( | bool | startAtClosestPoint | ) | [virtual] |
Flag indicating whether traversal should start at the beginning of route or at the closest point (which may be somewhere along the route).
Beginning is either 1st or last vertex, depending on traversal direction. By default, startAtClosestPoint is false.
| virtual bool DtMoveAlongTask::startAtClosestPoint | ( | ) | const [virtual] |
| virtual int DtMoveAlongTask::netRepSize | ( | ) | const [virtual] |
Rreturns the size of the full network representation (control object name included) padded to an 8-byte boundary.
Reimplemented from DtSimTask.
| virtual bool DtMoveAlongTask::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Fills in the task from the network buffer.
Reimplemented from DtSimTask.
| virtual bool DtMoveAlongTask::setToNet | ( | ) | [virtual] |
Fills in the network buffer (created by base class simTask) with the task contents.
Reimplemented from DtSimTask.
| static DtSimTask* DtMoveAlongTask::creator | ( | ) | [static] |
DtRwString DtMoveAlongTask::myRouteName [protected] |
DtRwInt DtMoveAlongTask::myTraversalDirection [protected] |
DtRwBoolean DtMoveAlongTask::myStartAtClosestPoint [protected] |