Requests that an application changes either state or mode of a platform part. More...
#include <WsfXIO_PacketRegistry.hpp>
Public Types | |
| enum | StateChange { cSTATE_COMMAND = 0x01000000 , cDEBUG_COMMAND = 0x02000000 , cMODE_COMMAND = 0x03000000 , cCUE_COMMAND = 0x04000000 , cXMTR_RCVR_COMMAND = 0x05000000 , cTRACKING_REQUEST_COMMAND = 0x06000000 , cCOMMAND_MASK = 0xff000000 , cNO_CHANGE = 0 , cTURN_ON = cSTATE_COMMAND | 1 , cTURN_OFF = cSTATE_COMMAND | 2 , cTURN_DEBUG_ON = cDEBUG_COMMAND | 1 , cTURN_DEBUG_OFF = cDEBUG_COMMAND | 2 , cDESELECT_MODE = cMODE_COMMAND | 1 , cCUE_AZ = cCUE_COMMAND | 1 , cCUE_EL = cCUE_COMMAND | 2 , cCUE_AZ_EL = cCUE_AZ | cCUE_EL , cCUE_WCS = cCUE_COMMAND | 4 , cCHANGE_XMTR = cXMTR_RCVR_COMMAND | 1 , cCHANGE_RCVR = cXMTR_RCVR_COMMAND | 2 , cXMTR_RCVR_MASK = cCHANGE_XMTR | cCHANGE_RCVR , cSET_POWER = 0x400 , cSET_BANDWIDTH = 0x800 , cSET_FREQUENCY = 0x1000 , cSET_DETECTION_THRESHOLD = 0x2000 , cSET_NOISE_FIGURE = 0x4000 , cSTART_TRACKING = cTRACKING_REQUEST_COMMAND | 0x01 , cSTOP_TRACKING = cTRACKING_REQUEST_COMMAND | 0x02 } |
| Public Types inherited from WsfXIO_Packet | |
| enum | PacketFlags { cSYNCHRONIZED = 1 } |
| typedef bool | BaseType |
Public Member Functions | |
| XIO_DEFINE_PACKET (WsfXIO_PartStateChangeRequestPkt, WsfXIO_Packet, 26) | |
| Public Member Functions inherited from WsfXIO_Packet | |
| WsfXIO_Packet (int aPacketId) | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| Serializes the packet header. Must be called first from derived class Serialize(). | |
| float | GetTimeStamp () const |
| void | SetTimeStamp (float aTimeStamp) |
| void | SetFlags (uint32_t aFlags) |
| void | AddFlags (uint32_t aFlags) |
| uint32_t | GetFlags () const |
Public Attributes | |
| int32_t | mPlatformIndex |
| Index of the owning platform. | |
| WsfStringId | mPartName |
| NameID of the platform part. | |
| int32_t | mPartType |
| Type of the platform part. | |
| int32_t | mStateChange |
| What kind of state change is applied. | |
| WsfStringId | mSelectMode |
| float | mCueAz |
| Azimuth to cue (relative to the part), if cCUE_AZ is set. | |
| float | mCueEl |
| Azimuth to cue (relative to the part), if cCUE_EL is set. | |
| UtVec3d | mCueWCS |
| Location to cue in WCS, if cCUE_WCS is set. | |
| int32_t | mXmtrIndex |
| double | mPower |
| New power to apply to xmtr. | |
| double | mBandwidth |
| New bandwidth to apply to xmtr/rcvr. | |
| double | mFrequency |
| New frequency to apply to xmtr/rcvr. | |
| double | mDetectionThreshold |
| New detection threshold to apply to rcvr. | |
| double | mNoiseFigure |
| New noise figure to apply to rcvr. | |
| WsfTrackId | mTrackId |
| For cSTART_TRACKING or cSTOP_TRACKING. | |
| int32_t | mTrackHostIndex |
| Public Attributes inherited from WsfXIO_Packet | |
| GenUniqueId | mApplicationId |
Additional Inherited Members | |
| Static Public Attributes inherited from WsfXIO_Packet | |
| static const int | cPACKET_ID = -1 |
| Protected Attributes inherited from WsfXIO_Packet | |
| uint32_t | mFlags |
| float | mTimeStamp |
Detailed Description
Requests that an application changes either state or mode of a platform part.
Member Enumeration Documentation
◆ StateChange
Member Function Documentation
◆ XIO_DEFINE_PACKET()
|
inline |
Member Data Documentation
◆ mBandwidth
| double WsfXIO_PartStateChangeRequestPkt::mBandwidth |
New bandwidth to apply to xmtr/rcvr.
Referenced by XIO_DEFINE_PACKET().
◆ mCueAz
| float WsfXIO_PartStateChangeRequestPkt::mCueAz |
Azimuth to cue (relative to the part), if cCUE_AZ is set.
Referenced by XIO_DEFINE_PACKET().
◆ mCueEl
| float WsfXIO_PartStateChangeRequestPkt::mCueEl |
Azimuth to cue (relative to the part), if cCUE_EL is set.
Referenced by XIO_DEFINE_PACKET().
◆ mCueWCS
| UtVec3d WsfXIO_PartStateChangeRequestPkt::mCueWCS |
Location to cue in WCS, if cCUE_WCS is set.
Referenced by XIO_DEFINE_PACKET().
◆ mDetectionThreshold
| double WsfXIO_PartStateChangeRequestPkt::mDetectionThreshold |
New detection threshold to apply to rcvr.
Referenced by XIO_DEFINE_PACKET().
◆ mFrequency
| double WsfXIO_PartStateChangeRequestPkt::mFrequency |
New frequency to apply to xmtr/rcvr.
Referenced by XIO_DEFINE_PACKET().
◆ mNoiseFigure
| double WsfXIO_PartStateChangeRequestPkt::mNoiseFigure |
New noise figure to apply to rcvr.
Referenced by XIO_DEFINE_PACKET().
◆ mPartName
| WsfStringId WsfXIO_PartStateChangeRequestPkt::mPartName |
NameID of the platform part.
Referenced by WsfXIO_WeaponComponent::HandleStateChangeRequest(), WsfXIO_PlatformPartInfo::InitStateChange(), WsfXIO_ModedPartInfo::SelectMode(), and XIO_DEFINE_PACKET().
◆ mPartType
| int32_t WsfXIO_PartStateChangeRequestPkt::mPartType |
Type of the platform part.
Referenced by WsfXIO_WeaponComponent::HandleStateChangeRequest(), WsfXIO_PlatformPartInfo::InitStateChange(), WsfXIO_ModedPartInfo::SelectMode(), and XIO_DEFINE_PACKET().
◆ mPlatformIndex
| int32_t WsfXIO_PartStateChangeRequestPkt::mPlatformIndex |
Index of the owning platform.
Referenced by WsfXIO_PlatformPartInfo::InitStateChange(), WsfXIO_ModedPartInfo::SelectMode(), and XIO_DEFINE_PACKET().
◆ mPower
| double WsfXIO_PartStateChangeRequestPkt::mPower |
New power to apply to xmtr.
Referenced by XIO_DEFINE_PACKET().
◆ mSelectMode
| WsfStringId WsfXIO_PartStateChangeRequestPkt::mSelectMode |
NameID of the new mode to select or deselect (0 for no change) or mode to start tracking with
Referenced by WsfXIO_WeaponComponent::HandleStateChangeRequest(), WsfXIO_ModedPartInfo::SelectMode(), and XIO_DEFINE_PACKET().
◆ mStateChange
| int32_t WsfXIO_PartStateChangeRequestPkt::mStateChange |
What kind of state change is applied.
Referenced by WsfXIO_WeaponComponent::HandleStateChangeRequest(), WsfXIO_PlatformPartInfo::InitStateChange(), WsfXIO_ModedPartInfo::SelectMode(), and XIO_DEFINE_PACKET().
◆ mTrackHostIndex
| int32_t WsfXIO_PartStateChangeRequestPkt::mTrackHostIndex |
For cSTART_TRACKING or cSTOP_TRACKING, defines the platform index on which the raw track is defined This may be set to zero for local tracks.
Referenced by XIO_DEFINE_PACKET().
◆ mTrackId
| WsfTrackId WsfXIO_PartStateChangeRequestPkt::mTrackId |
For cSTART_TRACKING or cSTOP_TRACKING.
Referenced by XIO_DEFINE_PACKET().
◆ mXmtrIndex
| int32_t WsfXIO_PartStateChangeRequestPkt::mXmtrIndex |
Index of transmitter that change applies to. If cCHANGE_RCVR is set, change will apply to linked receiver of this transmitter.
Referenced by WsfXIO_WeaponComponent::HandleStateChangeRequest(), and XIO_DEFINE_PACKET().
The documentation for this class was generated from the following file: