 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
File: railPathTask.h. More...
Public Member Functions | |
| DtRailRouteTask () | |
| default constructor | |
| DtRailRouteTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtRailRouteTask (const DtString &writeName, const DtRailRouteTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtRailRouteTask & | operator= (const DtRailRouteTask &orig) |
| assignment operator | |
| virtual | ~DtRailRouteTask () |
| virtual int | type () const |
| Returns "rail-route-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 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 |
| 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. | |
Static Public Member Functions | |
| static DtSimTask * | creator () |
Protected Attributes | |
| DtRwString | myRouteName |
| DtRwInt | myTraversalDirection |
| DtRwBoolean | myStartAtClosestPoint |
File: railPathTask.h.
Class: DtRailRouteTask DtRailRouteTask represents a rail task for an entity to perform using the specified route as a road.
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. This task can be used by any vehicle having a rail path planning controller. It indicates that the vehicle should use the provided route as a road defaulting it to a 2 lane road. The entity will use its defa switch to the rails movement system which locks the entity on to the path and optionally provide smooth turning around corners.
task-type: DtRailRouteType
default constructor
| DtRailRouteTask::DtRailRouteTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtRailRouteTask::DtRailRouteTask | ( | const DtString & | writeName, |
| const DtRailRouteTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtRailRouteTask::~DtRailRouteTask | ( | ) | [virtual] |
| const DtRailRouteTask& DtRailRouteTask::operator= | ( | const DtRailRouteTask & | orig | ) |
assignment operator
| virtual int DtRailRouteTask::type | ( | ) | const [virtual] |
Returns "rail-route-task".
Implements DtSimTask.
| virtual DtSimTask* DtRailRouteTask::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
Creates a copy of this task.
Implements DtSimTask.
| virtual DtString DtRailRouteTask::stringRep | ( | ) | const [virtual] |
Get a readable string representation of this task.
Implements DtSimTask.
| virtual const DtString& DtRailRouteTask::routeName | ( | ) | const [virtual] |
The string name of the route to be followed.
| virtual void DtRailRouteTask::setRouteName | ( | const DtString & | rteName | ) | [virtual] |
| virtual void DtRailRouteTask::setTraversalDirection | ( | DtIteratorDirection | traversalDirection | ) | [virtual] |
[DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false.
| virtual DtIteratorDirection DtRailRouteTask::traversalDirection | ( | ) | const [virtual] |
| virtual void DtRailRouteTask::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 DtRailRouteTask::startAtClosestPoint | ( | ) | const [virtual] |
| virtual int DtRailRouteTask::netRepSize | ( | ) | const [virtual] |
Returns the size in bytes of the network representation of the class.
This is the size in bytes of the DtNetSimTask structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).
Reimplemented from DtSimTask.
| virtual bool DtRailRouteTask::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().
Reimplemented from DtSimTask.
| virtual bool DtRailRouteTask::setToNet | ( | ) | [virtual] |
Calls netRep() to create the network buffer.
Casts the resulting myNetRep to type DtNetSimTask*, and then sets the mySubtask member in the DtNetSimTask from mySubtask. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimTask::netRepSize().
Reimplemented from DtSimTask.
| static DtSimTask* DtRailRouteTask::creator | ( | ) | [static] |
DtRwString DtRailRouteTask::myRouteName [protected] |
DtRwInt DtRailRouteTask::myTraversalDirection [protected] |
DtRwBoolean DtRailRouteTask::myStartAtClosestPoint [protected] |