WSF
WsfXIO_RequestSimTimePkt Class Reference

#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_RequestSimTimePkt:
Collaboration diagram for WsfXIO_RequestSimTimePkt:

Public Types

enum  TimerType : std::uint16_t { cSIM_TIME_INTERVAL , cADJUSTED_SIM_TIME_INTERVAL , cNO_TIME_INTERVAL , cREAL_TIME_INTERVAL }
Public Types inherited from WsfXIO_Packet
enum  PacketFlags { cSYNCHRONIZED = 1 }
typedef bool BaseType

Public Member Functions

 XIO_DEFINE_PACKET (WsfXIO_RequestSimTimePkt, WsfXIO_RequestDataPkt, 45)
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

TimerType mTimerType
double mTimerInterval
 Requested interval of simulation time updates.
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

Member Enumeration Documentation

◆ TimerType

Enumerator
cSIM_TIME_INTERVAL 

Specifies receipt of updates based on a simulation time interval 1.0 s interval / 10x clock rate = 10 updates per second

cADJUSTED_SIM_TIME_INTERVAL 

Specifies receipt of updates based on a simulation time interval adjusted by clock rate 1.0 s interval / 10x clock rate = 1 update per second

cNO_TIME_INTERVAL 

Specifies receipt of updates only when switching simulation state.

cREAL_TIME_INTERVAL 

Specifies that the interval is in real-time seconds. Useful for obtaining intermittent sim time updates.

Member Function Documentation

◆ XIO_DEFINE_PACKET()

WsfXIO_RequestSimTimePkt::XIO_DEFINE_PACKET ( WsfXIO_RequestSimTimePkt ,
WsfXIO_RequestDataPkt ,
45  )
inline

Member Data Documentation

◆ mTimerInterval

double WsfXIO_RequestSimTimePkt::mTimerInterval

Requested interval of simulation time updates.

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

◆ mTimerType

TimerType WsfXIO_RequestSimTimePkt::mTimerType

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