WsfXIO_TypeQueryPkt Class Reference

#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_TypeQueryPkt:

Collaboration diagram for WsfXIO_TypeQueryPkt:

Public Types
enum	TypeLocation {   cPART_TYPE , cPLATFORM_TYPE_MEMBER , cPLATFORM_MEMBER , cPLATFORM ,   cPLATFORM_TYPE }
Public Types inherited from WsfXIO_Packet
enum	PacketFlags { cSYNCHRONIZED = 1 }
typedef bool	BaseType

Public Member Functions
	XIO_DEFINE_PACKET (WsfXIO_TypeQueryPkt, WsfXIO_Packet, 36)
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
GenUniqueId	mQueryId
	Unique ID for the query.
TypeLocation	mTypeLocation
	Specifies where the type is defined.
int32_t	mPartType
	Type of platform part when using cPART_TYPE, cPLATFORM_TYPE_MEMBER, or cPLATFORM_MEMBER.
WsfStringId	mRequestedTypeName
	Name of the requested system.
WsfStringId	mPlatformName
	Must be valid for cPLATFORM_TYPE_MEMBER or cPLATFORM_MEMBER.
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

TypeLocation

enum WsfXIO_TypeQueryPkt::TypeLocation

Enumerator
cPART_TYPE	Object is defined as a platform part unassociated with a platform.
cPLATFORM_TYPE_MEMBER	Object is a member of a platform type named by mPlatformName.
cPLATFORM_MEMBER	Object is a member of a live platform named by mPlatformName;.
cPLATFORM	Object is a platform.
cPLATFORM_TYPE	Object is a platform_type.

Member Function Documentation

XIO_DEFINE_PACKET()

WsfXIO_TypeQueryPkt::XIO_DEFINE_PACKET ( WsfXIO_TypeQueryPkt , WsfXIO_Packet , 36  )

inline

References mPartType, mPlatformName, mQueryId, mRequestedTypeName, mTypeLocation, and WsfXIO_Packet::WsfXIO_Packet().

Member Data Documentation

mPartType

int32_t WsfXIO_TypeQueryPkt::mPartType

Type of platform part when using cPART_TYPE, cPLATFORM_TYPE_MEMBER, or cPLATFORM_MEMBER.

Referenced by WsfXIO_PlatformInfoService::FindObjectType(), and XIO_DEFINE_PACKET().

mPlatformName

WsfStringId WsfXIO_TypeQueryPkt::mPlatformName

Must be valid for cPLATFORM_TYPE_MEMBER or cPLATFORM_MEMBER.

Referenced by WsfXIO_PlatformInfoService::FindObjectType(), and XIO_DEFINE_PACKET().

mQueryId

GenUniqueId WsfXIO_TypeQueryPkt::mQueryId

Unique ID for the query.

Referenced by WsfXIO_PlatformInfoService::HandleTypeQuery(), and XIO_DEFINE_PACKET().

mRequestedTypeName

WsfStringId WsfXIO_TypeQueryPkt::mRequestedTypeName

Name of the requested system.

Referenced by WsfXIO_PlatformInfoService::FindObjectType(), WsfXIO_PlatformInfoService::HandleTypeQuery(), and XIO_DEFINE_PACKET().

mTypeLocation

TypeLocation WsfXIO_TypeQueryPkt::mTypeLocation

Specifies where the type is defined.

Referenced by WsfXIO_PlatformInfoService::FindObjectType(), WsfXIO_PlatformInfoService::HandleTypeQuery(), and XIO_DEFINE_PACKET().

---

The documentation for this class was generated from the following file:

• WsfXIO_PacketRegistry.hpp