Inform other applications about a platform part state change. More...
#include <WsfXIO_PacketRegistry.hpp>
Public Member Functions | |
| XIO_DEFINE_PACKET (WsfXIO_PartStateChangePkt, WsfXIO_ResponsePkt, 25) | |
| Public Member Functions inherited from WsfXIO_ResponsePkt | |
| XIO_DEFINE_PACKET_CTOR (WsfXIO_ResponsePkt, WsfXIO_Packet, 5) | |
| mFromProvider (false) | |
| mCompletesRequest (false) | |
| mRequestId (0) | |
| XIO_DEFINE_PACKET_SERIALIZE () | |
| 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. | |
| bool | mIsTurnedOn |
| 'true' if the part is turned on | |
| bool | mDebugOn |
| 'true' if debug is on | |
| double | mQuantityRemaining |
| Quantity remaining for objects. | |
| std::vector< WsfStringId > | mSelectedModes |
| List of selected mode names. | |
| WsfStringId | mCurrentModeName |
| Current mode name. | |
| Public Attributes inherited from WsfXIO_ResponsePkt | |
| bool | mFromProvider |
| bool | mCompletesRequest |
| If true, the receipt of this response indicates the request has been satisfied and should be closed. | |
| int32_t | mRequestId |
| Request ID. If this is 0, the packet is for any receiver. | |
| Public Attributes inherited from WsfXIO_Packet | |
| GenUniqueId | mApplicationId |
Additional Inherited Members | |
| Public Types inherited from WsfXIO_Packet | |
| enum | PacketFlags { cSYNCHRONIZED = 1 } |
| typedef bool | BaseType |
| 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
Inform other applications about a platform part state change.
Member Function Documentation
◆ XIO_DEFINE_PACKET()
|
inline |
References mCurrentModeName, mDebugOn, mIsTurnedOn, mPartName, mPartType, mPlatformIndex, mQuantityRemaining, and mSelectedModes.
Member Data Documentation
◆ mCurrentModeName
| WsfStringId WsfXIO_PartStateChangePkt::mCurrentModeName |
Current mode name.
Referenced by WsfXIO_PlatformInfoService::FillPartState(), WsfXIO_WeaponComponent::FillPartState(), WsfXIO_ModedPartInfo::UpdateFromStateChange(), and XIO_DEFINE_PACKET().
◆ mDebugOn
| bool WsfXIO_PartStateChangePkt::mDebugOn |
'true' if debug is on
Referenced by WsfXIO_PlatformInfoService::FillPartState(), and XIO_DEFINE_PACKET().
◆ mIsTurnedOn
| bool WsfXIO_PartStateChangePkt::mIsTurnedOn |
'true' if the part is turned on
Referenced by WsfXIO_PlatformInfoService::FillPartState(), WsfXIO_PlatformPartInfo::UpdateFromStateChange(), and XIO_DEFINE_PACKET().
◆ mPartName
| WsfStringId WsfXIO_PartStateChangePkt::mPartName |
NameID of the platform part.
Referenced by WsfXIO_PlatformInfoService::FillPartState(), and XIO_DEFINE_PACKET().
◆ mPartType
| int32_t WsfXIO_PartStateChangePkt::mPartType |
Type of the platform part.
Referenced by WsfXIO_PlatformInfoService::FillPartState(), WsfXIO_WeaponComponent::FillPartState(), and XIO_DEFINE_PACKET().
◆ mPlatformIndex
| int32_t WsfXIO_PartStateChangePkt::mPlatformIndex |
Index of the owning platform.
Referenced by WsfXIO_PlatformInfoService::SendPartState(), and XIO_DEFINE_PACKET().
◆ mQuantityRemaining
| double WsfXIO_PartStateChangePkt::mQuantityRemaining |
Quantity remaining for objects.
Referenced by WsfXIO_PlatformInfoService::FillPartState(), WsfXIO_WeaponComponent::FillPartState(), WsfXIO_WeaponInfo::UpdateFromStateChange(), and XIO_DEFINE_PACKET().
◆ mSelectedModes
| std::vector<WsfStringId> WsfXIO_PartStateChangePkt::mSelectedModes |
List of selected mode names.
Referenced by WsfXIO_PlatformInfoService::FillPartState(), WsfXIO_WeaponComponent::FillPartState(), WsfXIO_ModedPartInfo::UpdateFromStateChange(), and XIO_DEFINE_PACKET().
The documentation for this class was generated from the following file: