WSF
WsfXIO_RequestTracksPkt Class Reference

Requests that an application begin sending track information for a specified platform. More...

#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_RequestTracksPkt:
Collaboration diagram for WsfXIO_RequestTracksPkt:

Public Types

enum  TrackData {
  cRAW_TRACKS = 0x1 , cRAW_COASTED_TRACKS = 0x2 , cRAW_DROPPED_TRACKS = 0x4 , cLOCAL_TRACKS = 0x8 ,
  cLOCAL_DROPPED_TRACKS = 0xe , cALL = 0x1f
}
Public Types inherited from WsfXIO_Packet
enum  PacketFlags { cSYNCHRONIZED = 1 }
typedef bool BaseType

Public Member Functions

 XIO_DEFINE_PACKET_CTOR (WsfXIO_RequestTracksPkt, WsfXIO_RequestDataPkt, 8)
 mUpdateInterval (0.0)
 mRealtimeInterval (false)
 XIO_DEFINE_PACKET_SERIALIZE ()
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

int32_t mPlatformIndex
 Index of the platform whose tracks are requested.
WsfStringId mSensorNameId
bool mSendInitialTracks
int32_t mRequiredData
 Some combination of TrackData values.
double mUpdateInterval
bool mRealtimeInterval
 'True' if mUpdateInterval represents a change in real-time, not simulation-time
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 that an application begin sending track information for a specified platform.

Member Enumeration Documentation

◆ TrackData

Enumerator
cRAW_TRACKS 
cRAW_COASTED_TRACKS 
cRAW_DROPPED_TRACKS 
cLOCAL_TRACKS 
cLOCAL_DROPPED_TRACKS 
cALL 

Member Function Documentation

◆ mRealtimeInterval()

WsfXIO_RequestTracksPkt::mRealtimeInterval ( false )
inline

◆ mUpdateInterval()

WsfXIO_RequestTracksPkt::mUpdateInterval ( 0. 0)

◆ XIO_DEFINE_PACKET_CTOR()

WsfXIO_RequestTracksPkt::XIO_DEFINE_PACKET_CTOR ( WsfXIO_RequestTracksPkt ,
WsfXIO_RequestDataPkt ,
8  )

◆ XIO_DEFINE_PACKET_SERIALIZE()

WsfXIO_RequestTracksPkt::XIO_DEFINE_PACKET_SERIALIZE ( )
inline

Member Data Documentation

◆ mPlatformIndex

int32_t WsfXIO_RequestTracksPkt::mPlatformIndex

Index of the platform whose tracks are requested.

Referenced by WsfXIO_TrackRequest::Initialized(), WsfXIO_TrackService::SubscriptionCancelledT(), and XIO_DEFINE_PACKET_SERIALIZE().

◆ mRealtimeInterval

bool WsfXIO_RequestTracksPkt::mRealtimeInterval

'True' if mUpdateInterval represents a change in real-time, not simulation-time

Referenced by WsfXIO_TrackRequest::Initialized(), and XIO_DEFINE_PACKET_SERIALIZE().

◆ mRequiredData

int32_t WsfXIO_RequestTracksPkt::mRequiredData

Some combination of TrackData values.

Referenced by WsfXIO_TrackRequest::Initialized(), and XIO_DEFINE_PACKET_SERIALIZE().

◆ mSendInitialTracks

bool WsfXIO_RequestTracksPkt::mSendInitialTracks

'true' if tracks already in the track manager should be sent after the request is successful.

Referenced by WsfXIO_TrackRequest::Initialized(), and XIO_DEFINE_PACKET_SERIALIZE().

◆ mSensorNameId

WsfStringId WsfXIO_RequestTracksPkt::mSensorNameId

ID of the sensor whose tracks are requested Null if the platform's track manager's tracks are requested

Referenced by WsfXIO_TrackRequest::Initialized(), WsfXIO_TrackService::SubscriptionCancelledT(), and XIO_DEFINE_PACKET_SERIALIZE().

◆ mUpdateInterval

double WsfXIO_RequestTracksPkt::mUpdateInterval

Update interval for sending track updates. 0 indicates send on track update. If this is zero, XIO may broadcast track updates to multiple receivers.

Referenced by WsfXIO_TrackRequest::Initialized(), mRealtimeInterval(), WsfXIO_TrackService::SubscriptionCancelledT(), and XIO_DEFINE_PACKET_SERIALIZE().


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