MAK RTIspy API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
rtiAssistantLrcClient.h
Go to the documentation of this file.
1 /*********************************************************************
2  ** Copyright (c) 2008 MaK Technologies, Inc.
3  ** All rights reserved.
4  *********************************************************************/
5 /*******************************************************************************
6  ** $RCSfile: rtiAssistantLrcClient.h,v $ $Revision: 1.18 $ $State: Exp $
7  *******************************************************************************/
8 
9 #ifndef rtiAssistantLrcClient_H_
10 #define rtiAssistantLrcClient_H_
11 
15 #include <vlutil/vlFilename.h>
16 #include "rtiVersion.h"
17 #include "assistantConnectionInfo.h"
18 #include "rtiAssistantClient.h"
19 #include "rtiAmbAPITypes.h"
20 #include "fedAmbAPITypes.h"
21 #include "rtiMsgKind.h"
22 #include "internalTypes.h"
23 #include "assistantNetStatsEnums.h"
24 #include <vlutil/vlFedTarget.h>
25 
32 class DT_DLL_ASSISTANT DtRtiAssistantLrcClient : public DtRtiAssistantClient
33 {
34 public:
35 
36  DtRtiAssistantLrcClient( int port = 0 );
37  virtual ~DtRtiAssistantLrcClient();
38 
42  virtual void updateLrcName( const MAKRti::DtString& name );
43 
47  virtual void updateFederateName( const MAKRti::DtString& fedName );
48 
53  virtual void updateFederationInfo( unsigned long federationHandle,
54  const MAKRti::DtString& federationName, unsigned long fedHandle,
55  DtHlaVersionId hlaVersion );
56 
61  virtual void updateLrcLogFile( const MAKRti::DtFilename& file );
62 
67  virtual void updateLicenseServer( const MAKRti::DtString& server );
68 
72  virtual void updateConnInfo( const MAKRti::DtInetAddr& tcpAddr, int tcpPort, const MAKRti::DtInetAddr& tcpIntf,
73  const MAKRti::DtInetAddr& udpAddr, int udpPort, const MAKRti::DtInetAddr& udpIntf,
74  int forwarderPort, bool useRtiexec, bool fullCompliance);
75 
76  virtual void updateNetStats(bool enabled);
77 
80  virtual void sendClientInfo(bool isReconnect=false) override;
81 
82  virtual void sendNetStatsUpdate(DtFloat64 absTime, const std::vector<DtRtiAmbAPIType>& rtiAmbTypes,
83  const std::vector<DtU32>& rtiAmbNumCalls,
84  const std::vector<DtFloat64>& rtiAmbTotalTime,
85  const std::vector<DtFloat64>& rtiAmbAvgTime,
86  const std::vector<DtFloat64>& rtiAmbMinTime,
87  const std::vector<DtFloat64>& rtiAmbMaxTime,
88  const std::vector<DtFedAmbAPIType>& fedAmbTypes,
89  const std::vector<DtU32>& fedAmbNumCalls,
90  const std::vector<DtFloat64>& fedAmbTotalTime,
91  const std::vector<DtFloat64>& fedAmbAvgTime,
92  const std::vector<DtFloat64>& fedAmbMinTime,
93  const std::vector<DtFloat64>& fedAmbMaxTime,
94  const std::vector<DtRtiMsgKind>& msgKinds,
95  const std::vector<DtU32>& msgNumSent,
96  const std::vector<DtU32>& msgNumReceived,
97  const std::vector<DtU32>& msgBytesSent,
98  const std::vector<DtU32>& msgBytesReceived,
99  const std::vector<DtU32>& interactionClassHandles,
100  const std::vector<DtU32>& interactionUpdatesReceived,
101  const std::vector<DtU32>& interactionBytesReceived,
102  const std::vector<DtU32>& interactionUpdatesSent,
103  const std::vector<DtU32>& interactionBytesSent
104  );
105 
106  virtual void sendNetStatsStringUpdate(
107  const std::vector<DtU32>& objectClassHandles, const std::vector<MAKRti::DtString>& objectClassNames,
108  const std::vector<DtU32>& interactionClassHandles,
109  const std::vector<MAKRti::DtString>& interactionClassNames);
110  virtual void sendNetStatsAttrStringUpdate( const std::vector<MAKRti::DtU32>& objectClassHandles,
111  const std::vector<MAKRti::DtU32>& attributeHandles,
112  const std::vector<MAKRti::DtString>& attributeNames,
113  const std::vector<MAKRti::DtU32>& parentClassHandles,
114  const std::vector<MAKRti::DtU32>& totalObjHandles);
115  void sendNetStatsParamStringUpdate( const std::vector<MAKRti::DtU32>& interClassHandles,
116  const std::vector<MAKRti::DtU32>& parameterHandles,
117  const std::vector<MAKRti::DtString>& parameterNames,
118  const std::vector<MAKRti::DtU32>& parentInterHandles,
119  const std::vector<MAKRti::DtU32>& totalInterHandles);
120  virtual void sendNetStatsAttrParamStringUpdate( const std::vector<MAKRti::DtU32>& objectClassHandles,
121  const std::vector<MAKRti::DtU32>& attributeHandles, const std::vector<MAKRti::DtString>& attributeNames,
122  const std::vector<MAKRti::DtU32>& parentClassHandles,
123  const std::vector<MAKRti::DtU32>& totalObjHandles,
124  DtAssistantHandleType objInterType, DtAssistantHandleType attrParamType,
125  DtAssistantHandleType parentClassType );
126 
127  virtual void sendNetStatsFomAttrParamUpdate(DtAssistantHandleType handleType, bool isInit,
128  const std::vector<MAKRti::DtU32>& objectClassHandles, const std::vector<MAKRti::DtU32>& attributeHandles,
129  const std::vector<bool>& attributePub, const std::vector<bool>& attributeSub,
130  const std::vector<DtTransportType>& attributeTransport, const std::vector<DtOrderType>& attributeOrder,
131  const std::vector<bool>& objectPub, const std::vector<bool>& objectSub,
132  const std::vector<MAKRti::DtU32>& objPubSubHandles);
133 
134  virtual void sendObjectInstanceNetStatsStringUpdate( const std::vector<DtU32>& objectInstanceHandles,
135  const std::vector<MAKRti::DtString>& objectInstanceNames);
136  virtual void sendObjectInstanceNetStatsUpdate(DtFloat64 absTime,
137  const std::vector<DtU32>& objectInstanceHandles,
138  const std::vector<DtU32>& objectClassHandles,
139  const std::vector<DtU32>& objectUpdatesReceived,
140  const std::vector<DtU32>& objectBytesReceived,
141  const std::vector<DtU32>& objectUpdatesSent,
142  const std::vector<DtU32>& objectBytesSent);
143  virtual void sendFomTreeData(const std::vector<MAKRti::DtU32>& objectClassHandles,
144  const std::vector<MAKRti::DtU32>& parentObjectClassHandles,
145  const std::vector<MAKRti::DtString>& objectClassNames,
146  const std::vector<MAKRti::DtU32>& interactionClassHandles,
147  const std::vector<MAKRti::DtU32>& parentInteractionClassHandles,
148  const std::vector<MAKRti::DtString>& interactionClassNames);
149  virtual void sendFomUpdate(const std::vector<MAKRti::DtU32>& objectClassHandles, const std::vector<MAKRti::DtU32>& attributeHandles, const std::vector<bool>& attributePub, const std::vector<bool>& attributeSub, const std::vector<DtTransportType>& attributeTransport, const std::vector<DtOrderType>& attributeOrder, DtAssistantHandleType handleType, DtFloat64 absTime, bool isFullUpdate);
150 
151 protected:
152 
154  MAKRti::DtString myName;
155 
157  unsigned long myFedHandle;
158 
160  unsigned long myFederationHandle;
161 
163  MAKRti::DtString myFederationName;
164 
166  MAKRti::DtFilename myLogFile;
167 
169  MAKRti::DtString myLicServer;
170 
171  bool isNetStatsEnabled;
172 
174  MAKRti::DtInetAddr myTcpAddress;
175 
177  MAKRti::DtInetAddr myTcpInterface;
178 
180  MAKRti::DtInetAddr myUdpAddr;
181 
183  MAKRti::DtInetAddr myUdpInterface;
184 
186  int myUdpPort;
187 
189  int myTcpPort;
190 
192  bool myUseRtiexec;
193 
195  bool myFullCompliance;
196 
198  int myForwarderPort;
199 
201  MAKRti::DtString myFederateName;
202 
204  DtHlaVersionId myHlaVersion;
205 };
206 
207 
208 #endif
DtRtiAssistantLrcClient::isNetStatsEnabled
bool isNetStatsEnabled
Definition: rtiAssistantLrcClient.h:171
DtRtiAssistantLrcClient::myTcpAddress
MAKRti::DtInetAddr myTcpAddress
The RTI TCP IP address (used for reliable communication).
Definition: rtiAssistantLrcClient.h:174
DtRtiAssistantLrcClient::myLicServer
MAKRti::DtString myLicServer
The license server used by this LRC.
Definition: rtiAssistantLrcClient.h:169
DtRtiAssistantLrcClient::myFederateName
MAKRti::DtString myFederateName
The federate name.
Definition: rtiAssistantLrcClient.h:201
DtRtiAssistantClient
Manages the client connection to the RTI Assistant.
Definition: rtiAssistantClient.h:59
DtRtiAssistantLrcClient::myUdpAddr
MAKRti::DtInetAddr myUdpAddr
The RTI UDP IP address (used for best effort communication).
Definition: rtiAssistantLrcClient.h:180
assistantConnectionInfo.h
This file contains the declaration of DtRtiConnectionInfo.
DtRtiAssistantLrcClient::myHlaVersion
DtHlaVersionId myHlaVersion
The federate&#39;s HLA version.
Definition: rtiAssistantLrcClient.h:204
DtRtiAssistantLrcClient
The client connection to the RTI Assistant for an LRC.
Definition: rtiAssistantLrcClient.h:32
DtHlaVersionId
DtHlaVersionId
Definition: rtiVersion.h:51
DtRtiAssistantLrcClient::myUdpInterface
MAKRti::DtInetAddr myUdpInterface
The address of the network interface being used for UDP.
Definition: rtiAssistantLrcClient.h:183
DtRtiAssistantLrcClient::myUseRtiexec
bool myUseRtiexec
Whether use of an rtiexec is enabled.
Definition: rtiAssistantLrcClient.h:192
DtRtiAssistantLrcClient::myLogFile
MAKRti::DtFilename myLogFile
The name and full path of the log file.
Definition: rtiAssistantLrcClient.h:166
DtRtiAssistantLrcClient::myTcpInterface
MAKRti::DtInetAddr myTcpInterface
The address of the network interface being used for UDP.
Definition: rtiAssistantLrcClient.h:177
DtRtiAssistantLrcClient::myUdpPort
int myUdpPort
The RTI UDP port.
Definition: rtiAssistantLrcClient.h:186
DT_DLL_ASSISTANT
#define DT_DLL_ASSISTANT
Default – Unix or Win32 static.
Definition: rtiMsConfig.h:150
DtRtiAssistantLrcClient::myName
MAKRti::DtString myName
The name the Assistant uses to identify this LRC.
Definition: rtiAssistantLrcClient.h:154
DtRtiAssistantLrcClient::myFederationHandle
unsigned long myFederationHandle
This LRC&#39;s federation handle.
Definition: rtiAssistantLrcClient.h:160
DtRtiAssistantLrcClient::myFederationName
MAKRti::DtString myFederationName
This LRC&#39;s federation name.
Definition: rtiAssistantLrcClient.h:163
DtRtiAssistantLrcClient::myFullCompliance
bool myFullCompliance
Whether full compliance is enabled.
Definition: rtiAssistantLrcClient.h:195
rtiAssistantClient.h
Contains the DtRtiAssistantClient class declaration.
DtRtiAssistantClient::sendClientInfo
virtual void sendClientInfo(bool isReconnect=false)
intended to be over-ridden by subclasses.
DtAssistantHandleType
DtAssistantHandleType
Definition: assistantNetStatsEnums.h:23
DtRtiAssistantLrcClient::myFedHandle
unsigned long myFedHandle
This LRC&#39;s federate handle.
Definition: rtiAssistantLrcClient.h:157
internalTypes.h
The declaration of internal types.
DtRtiAssistantLrcClient::myTcpPort
int myTcpPort
The RTI TCP port.
Definition: rtiAssistantLrcClient.h:189
DtRtiAssistantLrcClient::myForwarderPort
int myForwarderPort
The port the forwarder uses to connect to other forwarders.
Definition: rtiAssistantLrcClient.h:198
Document ID: Generated on Wed Jul 8 16:20:32 EDT 2026 from SVN revision 291616
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)