MAK RTIspy API Documentation for HLA 1516
Classes | Macros | Enumerations
assistantMsg.h File Reference

Go to the source code of this file.

Classes

class  DtAssistantMsg
 Base class for assistant Messages. More...

Macros

#define DtASSISTANT_DEFAULT_PORT   6003
#define DtASSISTANT_DEFAULT_DEST_ID   0
#define DtASSISTANT_DEFAULT_IPV4_ADDR   "229.7.7.10"
#define DtASSISTANT_DEFAULT_IPV6_ADDR   "ff12::7:10"
#define DtASSISTANT_DEFAULT_TTL   1
#define DtAssistantMessageVersion   16

Enumerations

enum  DtAssistantMsgKind {
  DtAssistantConnMsgKind = 0, DtAssistantLrcCompInfoMsgKind = 1, DtAssistantRtiexecCompInfoMsgKind = 2, DtAssistantNotifyMsgKind = 3,
  DtAssistantConnQueryMsgKind = 4, DtAssistantNtfyLvlUpdateMsgKind = 5, DtAssistantExitMsgKind = 6, DtAssistantLicQueryMsgKind = 7,
  DtAssistantPopupMsgKind = 8, DtAssistantShmCompInfoMsgKind = 9, DtAssistantWwwCompInfoMsgKind = 10, DtAssistantRtiForwarderCompInfoMsgKind = 11,
  DtAssistantLogEnableMsgKind = 12, DtAssistantChangeLatencyTestModeMsgKind = 13, DtAssistantLatencyReportMsgKind = 14, DtAssistantTestMgrStatusMsgKind = 15,
  DtAssistantShutdownMsgKind = 16, DtAssistantStateObserveMsgKind = 17, DtAssistantDeleteFederateMsgKind = 18, DtAssistantDeleteFederationMsgKind = 19,
  DtAssistantNetworkTestEnableMsgKind = 20, DtAssistantFederationStateMsgKind = 21, DtAssistantFederateStateMsgKind = 22, DtAssistantTimeStateMsgKind = 23,
  DtAssistantSyncPtUpdateMsgKind = 24, DtAssistantCommandMsgKind = 25, DtAssistantExecStateMsgKind = 26, DtAssistantForwarderStateMsgKind = 27,
  DtAssistantRidParamsMsgKind = 28, DtAssistantLogRequestMsgKind = 29, DtAssistantLogMsgKind = 30, DtAssistantShowDialogMsgKind = 31,
  DtAssistantFederateSignalTickIntervalMsgKind = 32, DtAssistantSignalTickedMsgKind = 33, DtAssistantAwaitingForwardersMsgKind = 34, DtAssistantNotifyObserveMsgKind = 35,
  DtAssistantNetStatsObserveReqMsgKind = 36, DtAssistantNetStatsObserveRspMsgKind = 37, DtAssistantNetStatsMsgUpdateMsgKind = 38, DtAssistantNetStatsRtiAmbUpdateMsgKind = 39,
  DtAssistantNetStatsFedAmbUpdateMsgKind = 40, DtAssistantNetStatsObjectsUpdateMsgKind = 41, DtAssistantNetStatsInteractionsUpdateMsgKind = 42, DtAssistantNetStatsStringUpdateMsgKind = 43,
  DtAssistantNetStatsStringReqMsgKind = 44, DtAssistantNetStatsFomTreeUpdateMsgKind = 45, DtAssistantNetStatsFomUpdateMsgKind = 46, DtAssistantNetStatsAttrParamStringUpdateMsgKind = 47,
  DtAssistantNetStatsFomAttrParamUpdateMsgKind = 48, DtAssistantNetStatsInitStateRequestMsgKind = 49, DtAssistantQueryMsgKind = 254, DtAssistantInfoMsgKind = 253,
  DtAssistantRemovalMsgKind = 252, DtAssistantStartRtiexecMsgKind = 251, DtAssistantExecObserveRspMsgKind = 250, DtAssistantLightweightInfoMsgKind = 249,
  DtAssistantLicServerInfoMsgKind = 248, DtAssistantFederateReqMsgKind = 247, DtAssistantFederateRespMsgKind = 246, DtInvalidAssistantMsgKind = 255
}
enum  DtAssistantMsgReadStatus {
  DtASSISTANT_READ_SUCCESS = 0, DtASSISTANT_READ_NO_PACKETS, DtASSISTANT_READ_BAD_PACKET, DtASSISTANT_READ_SERVER_MSG,
  DtASSISTANT_READ_SIZE_MISMATCH, DtASSISTANT_READ_FILTERED_PACKET, DtASSISTANT_QUEUED_PACKET, DtASSISTANT_INVALID_VERSION,
  DtASSISTANT_UNKNOWN_ERROR, DtASSISTANT_BUFFER_TOO_SMALL
}
enum  DtAssistantMsgFederateStatus { DtASSISTANT_UNKNOWN = 0, DtASSISTANT_NORMAL, DtASSISTANT_NOT_JOINED, DtASSISTANT_DROPPED }

Detailed Description

Macro Definition Documentation

#define DtASSISTANT_DEFAULT_DEST_ID   0
#define DtASSISTANT_DEFAULT_IPV4_ADDR   "229.7.7.10"
#define DtASSISTANT_DEFAULT_IPV6_ADDR   "ff12::7:10"
#define DtASSISTANT_DEFAULT_PORT   6003
#define DtASSISTANT_DEFAULT_TTL   1
#define DtAssistantMessageVersion   16

Enumeration Type Documentation

Enumerator:
DtASSISTANT_UNKNOWN 
DtASSISTANT_NORMAL 
DtASSISTANT_NOT_JOINED 
DtASSISTANT_DROPPED 
Enumerator:
DtAssistantConnMsgKind 
DtAssistantLrcCompInfoMsgKind 
DtAssistantRtiexecCompInfoMsgKind 
DtAssistantNotifyMsgKind 
DtAssistantConnQueryMsgKind 
DtAssistantNtfyLvlUpdateMsgKind 
DtAssistantExitMsgKind 
DtAssistantLicQueryMsgKind 
DtAssistantPopupMsgKind 
DtAssistantShmCompInfoMsgKind 
DtAssistantWwwCompInfoMsgKind 
DtAssistantRtiForwarderCompInfoMsgKind 
DtAssistantLogEnableMsgKind 
DtAssistantChangeLatencyTestModeMsgKind 
DtAssistantLatencyReportMsgKind 
DtAssistantTestMgrStatusMsgKind 
DtAssistantShutdownMsgKind 
DtAssistantStateObserveMsgKind 
DtAssistantDeleteFederateMsgKind 
DtAssistantDeleteFederationMsgKind 
DtAssistantNetworkTestEnableMsgKind 
DtAssistantFederationStateMsgKind 
DtAssistantFederateStateMsgKind 
DtAssistantTimeStateMsgKind 
DtAssistantSyncPtUpdateMsgKind 
DtAssistantCommandMsgKind 
DtAssistantExecStateMsgKind 
DtAssistantForwarderStateMsgKind 
DtAssistantRidParamsMsgKind 
DtAssistantLogRequestMsgKind 
DtAssistantLogMsgKind 
DtAssistantShowDialogMsgKind 
DtAssistantFederateSignalTickIntervalMsgKind 
DtAssistantSignalTickedMsgKind 
DtAssistantAwaitingForwardersMsgKind 
DtAssistantNotifyObserveMsgKind 
DtAssistantNetStatsObserveReqMsgKind 
DtAssistantNetStatsObserveRspMsgKind 
DtAssistantNetStatsMsgUpdateMsgKind 
DtAssistantNetStatsRtiAmbUpdateMsgKind 
DtAssistantNetStatsFedAmbUpdateMsgKind 
DtAssistantNetStatsObjectsUpdateMsgKind 
DtAssistantNetStatsInteractionsUpdateMsgKind 
DtAssistantNetStatsStringUpdateMsgKind 
DtAssistantNetStatsStringReqMsgKind 
DtAssistantNetStatsFomTreeUpdateMsgKind 
DtAssistantNetStatsFomUpdateMsgKind 
DtAssistantNetStatsAttrParamStringUpdateMsgKind 
DtAssistantNetStatsFomAttrParamUpdateMsgKind 
DtAssistantNetStatsInitStateRequestMsgKind 
DtAssistantQueryMsgKind 
DtAssistantInfoMsgKind 
DtAssistantRemovalMsgKind 
DtAssistantStartRtiexecMsgKind 
DtAssistantExecObserveRspMsgKind 
DtAssistantLightweightInfoMsgKind 
DtAssistantLicServerInfoMsgKind 
DtAssistantFederateReqMsgKind 
DtAssistantFederateRespMsgKind 
DtInvalidAssistantMsgKind 

Note: no message kind may be > DtInvalidAssistantMsgKind This is a limitation imposed by the Assistant Msg Header - it uses 8-bits for msgkind, so 255 is the highest valid kind DtInvalidAssistantMsgKind acts as a flag for the last valid kind.

Enumerator:
DtASSISTANT_READ_SUCCESS 
DtASSISTANT_READ_NO_PACKETS 
DtASSISTANT_READ_BAD_PACKET 
DtASSISTANT_READ_SERVER_MSG 
DtASSISTANT_READ_SIZE_MISMATCH 
DtASSISTANT_READ_FILTERED_PACKET 
DtASSISTANT_QUEUED_PACKET 
DtASSISTANT_INVALID_VERSION 
DtASSISTANT_UNKNOWN_ERROR 
DtASSISTANT_BUFFER_TOO_SMALL 

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)