WSF
WsfXIO_MessageRequestPkt Class Reference

Requests messages sent or received by a platform. More...

#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_MessageRequestPkt:
Collaboration diagram for WsfXIO_MessageRequestPkt:

Public Types

enum  RequestedMessageType : std::uint16_t { cRECEIVED_MESSAGES = 0x1 , cSENT_MESSAGES = 0x2 , cALL_MESSAGES = cRECEIVED_MESSAGES | cSENT_MESSAGES }
Public Types inherited from WsfXIO_Packet
enum  PacketFlags { cSYNCHRONIZED = 1 }
typedef bool BaseType

Public Member Functions

 XIO_DEFINE_PACKET (WsfXIO_MessageRequestPkt, WsfXIO_RequestDataPkt, 40)
Public Member Functions inherited from WsfXIO_RequestDataPkt
 WsfXIO_RequestDataPkt (int aPacketId)
template<typename T>
void Serialize (T &aBuff)
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

uint16_t mRequestedMessages
 One of RequestedMessageType.
std::int32_t mPlatformIndex
 Index of the platform sending/receiving the message.
Public Attributes inherited from WsfXIO_RequestDataPkt
int32_t mSubscriptionRequestId
bool mReliable
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 messages sent or received by a platform.

Member Enumeration Documentation

◆ RequestedMessageType

Enumerator
cRECEIVED_MESSAGES 
cSENT_MESSAGES 
cALL_MESSAGES 

Member Function Documentation

◆ XIO_DEFINE_PACKET()

WsfXIO_MessageRequestPkt::XIO_DEFINE_PACKET ( WsfXIO_MessageRequestPkt ,
WsfXIO_RequestDataPkt ,
40  )
inline

Member Data Documentation

◆ mPlatformIndex

std::int32_t WsfXIO_MessageRequestPkt::mPlatformIndex

Index of the platform sending/receiving the message.

Referenced by WsfXIO_MessageService::HandleRequest(), and XIO_DEFINE_PACKET().

◆ mRequestedMessages

uint16_t WsfXIO_MessageRequestPkt::mRequestedMessages

The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved