WSF
WsfXIO_RequestPlatformInfoPkt Class Reference

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

#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_RequestPlatformInfoPkt:
Collaboration diagram for WsfXIO_RequestPlatformInfoPkt:

Public Types

enum  {
  cPLATFORM_INFO = 0x40000000 , cCOMMAND_CHAIN_INFO = 0x20000000 , cENTITY_STATE_INFO = 0x10000000 , cROUTE_INFO = 0x08000000 ,
  cSENSOR_INFO = 0x00000001 , cPROCESSOR_INFO = 0x00000002 , cCOMM_INFO = 0x00000004 , cMOVER_INFO = 0x00000008 ,
  cPART_1_INFO = 0x00000010 , cPART_2_INFO = 0x00000020 , cPART_3_INFO = 0x00000040 , cPART_4_INFO = 0x00000080 ,
  cALL_PART_X_INFO = cPART_1_INFO | cPART_2_INFO | cPART_3_INFO | cPART_4_INFO , cPART_INFO = cSENSOR_INFO | cPROCESSOR_INFO | cCOMM_INFO | cMOVER_INFO | cALL_PART_X_INFO , cALL_INFO = cCOMMAND_CHAIN_INFO | cPLATFORM_INFO | cPART_INFO
}
 Bit mask for various types of information that can be requested. More...
typedef uint32_t InfoType
Public Types inherited from WsfXIO_Packet
enum  PacketFlags { cSYNCHRONIZED = 1 }
typedef bool BaseType

Public Member Functions

 XIO_DEFINE_PACKET (WsfXIO_RequestPlatformInfoPkt, WsfXIO_RequestDataPkt, 24)
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 from which information is requested.
InfoType mInfoTypes
 Type of information requested. A combination of InfoType flags.
bool mUseDeadReckonDefaults
 If 'true', use the default dead-reckon parameters in Ext, may require less overhead.
double mDeadReckonInterval
 Interval at which dead reckoning is evaluated.
double mMaxDeadReckonError
 Maximum positional error before new entity state is sent.
double mMaxDeadReckonOrientationError
 Maximum angular orientation error before new entity state is sent.
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 information for a specified platform.

Member Typedef Documentation

◆ InfoType

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Bit mask for various types of information that can be requested.

Enumerator
cPLATFORM_INFO 
cCOMMAND_CHAIN_INFO 
cENTITY_STATE_INFO 
cROUTE_INFO 
cSENSOR_INFO 
cPROCESSOR_INFO 
cCOMM_INFO 
cMOVER_INFO 
cPART_1_INFO 
cPART_2_INFO 
cPART_3_INFO 
cPART_4_INFO 
cALL_PART_X_INFO 
cPART_INFO 
cALL_INFO 

Member Function Documentation

◆ XIO_DEFINE_PACKET()

Member Data Documentation

◆ mDeadReckonInterval

double WsfXIO_RequestPlatformInfoPkt::mDeadReckonInterval

Interval at which dead reckoning is evaluated.

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_PlatformInfoRequest::Initialized(), and XIO_DEFINE_PACKET().

◆ mInfoTypes

InfoType WsfXIO_RequestPlatformInfoPkt::mInfoTypes

Type of information requested. A combination of InfoType flags.

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_PlatformInfoRequest::Initialized(), and XIO_DEFINE_PACKET().

◆ mMaxDeadReckonError

double WsfXIO_RequestPlatformInfoPkt::mMaxDeadReckonError

Maximum positional error before new entity state is sent.

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_PlatformInfoRequest::Initialized(), and XIO_DEFINE_PACKET().

◆ mMaxDeadReckonOrientationError

double WsfXIO_RequestPlatformInfoPkt::mMaxDeadReckonOrientationError

Maximum angular orientation error before new entity state is sent.

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_PlatformInfoRequest::Initialized(), and XIO_DEFINE_PACKET().

◆ mPlatformIndex

int32_t WsfXIO_RequestPlatformInfoPkt::mPlatformIndex

◆ mUseDeadReckonDefaults

bool WsfXIO_RequestPlatformInfoPkt::mUseDeadReckonDefaults

If 'true', use the default dead-reckon parameters in Ext, may require less overhead.

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_PlatformInfoRequest::Initialized(), and XIO_DEFINE_PACKET().


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