 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
DtSetWarheadInfo is used to specify data to a DtWarheadDetonationActuator. More...
Public Member Functions | |
| DtSetWarheadInfo () | |
| default constructor | |
| DtSetWarheadInfo (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a request 'put' itself, the writeName will preface it. | |
| DtSetWarheadInfo (const DtString &writeName, const DtSetWarheadInfo &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSetWarheadInfo & | operator= (const DtSetWarheadInfo &orig) |
| assignment operator | |
| virtual | ~DtSetWarheadInfo () |
| virtual int | type () const |
| Returns DtSetWarheadInfoType. | |
| virtual DtSetDataRequest * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of the request. | |
| virtual DtString | stringRep () const |
| Get a readable string representation of this setDataRequest. | |
| virtual void | setWarheadType (DtWarheadType wh) |
| Set/get the warhead type. | |
| virtual DtWarheadType | warheadType () const |
| virtual bool | warheadTypeSpecified () const |
| virtual void | setFuzeType (DtDetonatorFuze fuze) |
| Set/get the fuze type. | |
| virtual DtDetonatorFuze | fuzeType () const |
| virtual bool | fuzeTypeSpecified () const |
| virtual void | setAttacker (const DtString &name) |
| Set/get the name of the attacker. | |
| virtual DtString | attacker () const |
| virtual bool | attackerSpecified () const |
| virtual void | setEventIdString (const DtString &eventId) |
| Set/get the event ID. | |
| virtual DtString | eventIdString () const |
| virtual bool | eventIdSpecified () const |
| virtual void | setTargetName (const DtString &target) |
| Set/get the target name. | |
| virtual DtString | targetName () const |
| virtual bool | targetNameSpecified () const |
| virtual void | setDetonationProximity (DtReal proximity) |
| Set/get the detonation proximity. | |
| virtual DtReal | detonationProximity () const |
| virtual bool | detonationProximitySpecified () const |
| 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. | |
Static Public Member Functions | |
| static DtSetDataRequest * | creator () |
Protected Attributes | |
| DtRwInt | myWarheadType |
| DtRwInt | myFuzeType |
| DtRwString | myAttacker |
| DtRwString | myEventIdString |
| DtRwString | myTargetName |
| DtRwReal | myDetonationProximity |
DtSetWarheadInfo is used to specify data to a DtWarheadDetonationActuator.
The Warhead type, fuze type, attack name, detonation event ID, target name detonation proximity are all set through this set data request. Not all fields must be set. Data is preserved within the message on which fields have been set, and which have not. This is accessed though the xxxSpecified() calls for each field. The specified flag is set to true automatically when a mutator is called for that field.
default constructor
| DtSetWarheadInfo::DtSetWarheadInfo | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a request 'put' itself, the writeName will preface it.
| DtSetWarheadInfo::DtSetWarheadInfo | ( | const DtString & | writeName, |
| const DtSetWarheadInfo & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtSetWarheadInfo::~DtSetWarheadInfo | ( | ) | [virtual] |
| const DtSetWarheadInfo& DtSetWarheadInfo::operator= | ( | const DtSetWarheadInfo & | orig | ) |
assignment operator
| virtual int DtSetWarheadInfo::type | ( | ) | const [virtual] |
Returns DtSetWarheadInfoType.
Implements DtSetDataRequest.
| virtual DtSetDataRequest* DtSetWarheadInfo::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
Creates a copy of the request.
Implements DtSetDataRequest.
| virtual DtString DtSetWarheadInfo::stringRep | ( | ) | const [virtual] |
Get a readable string representation of this setDataRequest.
Implements DtSetDataRequest.
| virtual void DtSetWarheadInfo::setWarheadType | ( | DtWarheadType | wh | ) | [virtual] |
Set/get the warhead type.
| virtual DtWarheadType DtSetWarheadInfo::warheadType | ( | ) | const [virtual] |
| virtual bool DtSetWarheadInfo::warheadTypeSpecified | ( | ) | const [virtual] |
| virtual void DtSetWarheadInfo::setFuzeType | ( | DtDetonatorFuze | fuze | ) | [virtual] |
Set/get the fuze type.
| virtual DtDetonatorFuze DtSetWarheadInfo::fuzeType | ( | ) | const [virtual] |
| virtual bool DtSetWarheadInfo::fuzeTypeSpecified | ( | ) | const [virtual] |
| virtual void DtSetWarheadInfo::setAttacker | ( | const DtString & | name | ) | [virtual] |
Set/get the name of the attacker.
| virtual DtString DtSetWarheadInfo::attacker | ( | ) | const [virtual] |
| virtual bool DtSetWarheadInfo::attackerSpecified | ( | ) | const [virtual] |
| virtual void DtSetWarheadInfo::setEventIdString | ( | const DtString & | eventId | ) | [virtual] |
Set/get the event ID.
The event ID must be passed in its string form in the message because the DtEventId class is different in HLA and DIS.
| virtual DtString DtSetWarheadInfo::eventIdString | ( | ) | const [virtual] |
| virtual bool DtSetWarheadInfo::eventIdSpecified | ( | ) | const [virtual] |
| virtual void DtSetWarheadInfo::setTargetName | ( | const DtString & | target | ) | [virtual] |
Set/get the target name.
The warhead only needs a target name if it is intended to detonate on proximity to the target.
| virtual DtString DtSetWarheadInfo::targetName | ( | ) | const [virtual] |
| virtual bool DtSetWarheadInfo::targetNameSpecified | ( | ) | const [virtual] |
| virtual void DtSetWarheadInfo::setDetonationProximity | ( | DtReal | proximity | ) | [virtual] |
Set/get the detonation proximity.
The warhead needs a target to detonate within proximity of, if this behavior is desired.
| virtual DtReal DtSetWarheadInfo::detonationProximity | ( | ) | const [virtual] |
| virtual bool DtSetWarheadInfo::detonationProximitySpecified | ( | ) | const [virtual] |
| virtual int DtSetWarheadInfo::netRepSize | ( | ) | const [virtual] |
Returns the size of the full network representation padded to an 8-byte boundary.
Reimplemented from DtSetDataRequest.
| virtual bool DtSetWarheadInfo::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Fills in the task from the network buffer.
Reimplemented from DtSetDataRequest.
| virtual bool DtSetWarheadInfo::setToNet | ( | ) | [virtual] |
Fills in the network buffer (created by base class simTask) with the task contents.
Reimplemented from DtSetDataRequest.
| static DtSetDataRequest* DtSetWarheadInfo::creator | ( | ) | [static] |
DtRwInt DtSetWarheadInfo::myWarheadType [protected] |
DtRwInt DtSetWarheadInfo::myFuzeType [protected] |
DtRwString DtSetWarheadInfo::myAttacker [protected] |
DtRwString DtSetWarheadInfo::myEventIdString [protected] |
DtRwString DtSetWarheadInfo::myTargetName [protected] |
DtRwReal DtSetWarheadInfo::myDetonationProximity [protected] |