 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
File: launchExpendableResourceTask.h. More...
Public Member Functions | |
| DtLaunchExpendableResourceTask () | |
| default constructor | |
| DtLaunchExpendableResourceTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtLaunchExpendableResourceTask (const DtString &writeName, const DtLaunchExpendableResourceTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtLaunchExpendableResourceTask & | operator= (const DtLaunchExpendableResourceTask &orig) |
| assignment operator | |
| virtual | ~DtLaunchExpendableResourceTask () |
| 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 & | expendableResourceName () const |
| The string name of the route to be followed. | |
| virtual void | setExpendableResourceName (const DtString &name) |
| virtual const int | numberToFire () const |
| The number of this resources to fire. | |
| virtual void | setNumberToFire (const int number) |
| virtual const double | timeIntervalBetweenFiring () const |
| The time interval between each firing of the resource. | |
| virtual void | setTimeIntervalBetweenFiring (const double interval) |
| 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 | myExpendableResourceName |
| DtRwInt | myNumberToFire |
| DtRwReal | myTimeInterval |
File: launchExpendableResourceTask.h.
Class: DtLaunchExpendableResourceTask DtLaunchExpendableResourceTask represents a launching task where by the entity will launch the specified expendable resource like chaff, bombs, food drops...what ever you want to drop out your vehicle! The string name of the resource to fire is specified as a parameter of the task. The number of this resource to fire and any time interval desired between firing of each resource are also parameters of this task.
task-type: DtLaunchExpendableResourceTaskType
default constructor
| DtLaunchExpendableResourceTask::DtLaunchExpendableResourceTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtLaunchExpendableResourceTask::DtLaunchExpendableResourceTask | ( | const DtString & | writeName, |
| const DtLaunchExpendableResourceTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtLaunchExpendableResourceTask::~DtLaunchExpendableResourceTask | ( | ) | [virtual] |
| const DtLaunchExpendableResourceTask& DtLaunchExpendableResourceTask::operator= | ( | const DtLaunchExpendableResourceTask & | orig | ) |
assignment operator
| virtual int DtLaunchExpendableResourceTask::type | ( | ) | const [virtual] |
Returns "rail-route-task".
Implements DtSimTask.
| virtual DtSimTask* DtLaunchExpendableResourceTask::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
Creates a copy of this task.
Implements DtSimTask.
| virtual DtString DtLaunchExpendableResourceTask::stringRep | ( | ) | const [virtual] |
Get a readable string representation of this task.
Implements DtSimTask.
| virtual const DtString& DtLaunchExpendableResourceTask::expendableResourceName | ( | ) | const [virtual] |
The string name of the route to be followed.
| virtual void DtLaunchExpendableResourceTask::setExpendableResourceName | ( | const DtString & | name | ) | [virtual] |
| virtual const int DtLaunchExpendableResourceTask::numberToFire | ( | ) | const [virtual] |
The number of this resources to fire.
| virtual void DtLaunchExpendableResourceTask::setNumberToFire | ( | const int | number | ) | [virtual] |
| virtual const double DtLaunchExpendableResourceTask::timeIntervalBetweenFiring | ( | ) | const [virtual] |
The time interval between each firing of the resource.
| virtual void DtLaunchExpendableResourceTask::setTimeIntervalBetweenFiring | ( | const double | interval | ) | [virtual] |
| virtual int DtLaunchExpendableResourceTask::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 DtLaunchExpendableResourceTask::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 DtLaunchExpendableResourceTask::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* DtLaunchExpendableResourceTask::creator | ( | ) | [static] |