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 
79  virtual void sendClientInfo();
80 
81  virtual void sendNetStatsUpdate(DtFloat64 absTime, const std::vector<DtRtiAmbAPIType>& rtiAmbTypes,
82  const std::vector<DtU32>& rtiAmbNumCalls,
83  const std::vector<DtFloat64>& rtiAmbTotalTime,
84  const std::vector<DtFloat64>& rtiAmbAvgTime,
85  const std::vector<DtFloat64>& rtiAmbMinTime,
86  const std::vector<DtFloat64>& rtiAmbMaxTime,
87  const std::vector<DtFedAmbAPIType>& fedAmbTypes,
88  const std::vector<DtU32>& fedAmbNumCalls,
89  const std::vector<DtFloat64>& fedAmbTotalTime,
90  const std::vector<DtFloat64>& fedAmbAvgTime,
91  const std::vector<DtFloat64>& fedAmbMinTime,
92  const std::vector<DtFloat64>& fedAmbMaxTime,
93  const std::vector<DtRtiMsgKind>& msgKinds,
94  const std::vector<DtU32>& msgNumSent,
95  const std::vector<DtU32>& msgNumReceived,
96  const std::vector<DtU32>& msgBytesSent,
97  const std::vector<DtU32>& msgBytesReceived,
98  const std::vector<DtU32>& interactionClassHandles,
99  const std::vector<DtU32>& interactionUpdatesReceived,
100  const std::vector<DtU32>& interactionBytesReceived,
101  const std::vector<DtU32>& interactionUpdatesSent,
102  const std::vector<DtU32>& interactionBytesSent
103  );
104 
105  virtual void sendNetStatsStringUpdate(
106  const std::vector<DtU32>& objectClassHandles, const std::vector<MAKRti::DtString>& objectClassNames,
107  const std::vector<DtU32>& interactionClassHandles,
108  const std::vector<MAKRti::DtString>& interactionClassNames);
109  virtual void sendNetStatsAttrStringUpdate( const std::vector<MAKRti::DtU32>& objectClassHandles,
110  const std::vector<MAKRti::DtU32>& attributeHandles,
111  const std::vector<MAKRti::DtString>& attributeNames,
112  const std::vector<MAKRti::DtU32>& parentClassHandles,
113  const std::vector<MAKRti::DtU32>& totalObjHandles);
114  void sendNetStatsParamStringUpdate( const std::vector<MAKRti::DtU32>& interClassHandles,
115  const std::vector<MAKRti::DtU32>& parameterHandles,
116  const std::vector<MAKRti::DtString>& parameterNames,
117  const std::vector<MAKRti::DtU32>& parentInterHandles,
118  const std::vector<MAKRti::DtU32>& totalInterHandles);
119  virtual void sendNetStatsAttrParamStringUpdate( const std::vector<MAKRti::DtU32>& objectClassHandles,
120  const std::vector<MAKRti::DtU32>& attributeHandles, const std::vector<MAKRti::DtString>& attributeNames,
121  const std::vector<MAKRti::DtU32>& parentClassHandles,
122  const std::vector<MAKRti::DtU32>& totalObjHandles,
123  DtAssistantHandleType objInterType, DtAssistantHandleType attrParamType,
124  DtAssistantHandleType parentClassType );
125 
126  virtual void sendNetStatsFomAttrParamUpdate(DtAssistantHandleType handleType, bool isInit,
127  const std::vector<MAKRti::DtU32>& objectClassHandles, const std::vector<MAKRti::DtU32>& attributeHandles,
128  const std::vector<bool>& attributePub, const std::vector<bool>& attributeSub,
129  const std::vector<DtTransportType>& attributeTransport, const std::vector<DtOrderType>& attributeOrder,
130  const std::vector<bool>& objectPub, const std::vector<bool>& objectSub,
131  const std::vector<MAKRti::DtU32>& objPubSubHandles);
132 
133  virtual void sendObjectInstanceNetStatsStringUpdate( const std::vector<DtU32>& objectInstanceHandles,
134  const std::vector<MAKRti::DtString>& objectInstanceNames);
135  virtual void sendObjectInstanceNetStatsUpdate(DtFloat64 absTime,
136  const std::vector<DtU32>& objectInstanceHandles,
137  const std::vector<DtU32>& objectClassHandles,
138  const std::vector<DtU32>& objectUpdatesReceived,
139  const std::vector<DtU32>& objectBytesReceived,
140  const std::vector<DtU32>& objectUpdatesSent,
141  const std::vector<DtU32>& objectBytesSent);
142  virtual void sendFomTreeData(const std::vector<MAKRti::DtU32>& objectClassHandles,
143  const std::vector<MAKRti::DtU32>& parentObjectClassHandles,
144  const std::vector<MAKRti::DtString>& objectClassNames,
145  const std::vector<MAKRti::DtU32>& interactionClassHandles,
146  const std::vector<MAKRti::DtU32>& parentInteractionClassHandles,
147  const std::vector<MAKRti::DtString>& interactionClassNames);
148  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);
149 
150 protected:
151 
153  MAKRti::DtString myName;
154 
156  unsigned long myFedHandle;
157 
159  unsigned long myFederationHandle;
160 
162  MAKRti::DtString myFederationName;
163 
165  MAKRti::DtFilename myLogFile;
166 
168  MAKRti::DtString myLicServer;
169 
170  bool isNetStatsEnabled;
171 
173  MAKRti::DtInetAddr myTcpAddress;
174 
176  MAKRti::DtInetAddr myTcpInterface;
177 
179  MAKRti::DtInetAddr myUdpAddr;
180 
182  MAKRti::DtInetAddr myUdpInterface;
183 
185  int myUdpPort;
186 
188  int myTcpPort;
189 
191  bool myUseRtiexec;
192 
194  bool myFullCompliance;
195 
197  int myForwarderPort;
198 
200  MAKRti::DtString myFederateName;
201 
203  DtHlaVersionId myHlaVersion;
204 };
205 
206 
207 #endif
DtRtiAssistantLrcClient::isNetStatsEnabled
bool isNetStatsEnabled
Definition: rtiAssistantLrcClient.h:170
DtRtiAssistantLrcClient::myTcpAddress
MAKRti::DtInetAddr myTcpAddress
The RTI TCP IP address (used for reliable communication).
Definition: rtiAssistantLrcClient.h:173
DtRtiAssistantLrcClient::myLicServer
MAKRti::DtString myLicServer
The license server used by this LRC.
Definition: rtiAssistantLrcClient.h:168
DtRtiAssistantLrcClient::myFederateName
MAKRti::DtString myFederateName
The federate name.
Definition: rtiAssistantLrcClient.h:200
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:179
assistantConnectionInfo.h
This file contains the declaration of DtRtiConnectionInfo.
DtRtiAssistantLrcClient::myHlaVersion
DtHlaVersionId myHlaVersion
The federate&#39;s HLA version.
Definition: rtiAssistantLrcClient.h:203
DtRtiAssistantLrcClient
The client connection to the RTI Assistant for an LRC.
Definition: rtiAssistantLrcClient.h:32
DtHlaVersionId
DtHlaVersionId
Definition: rtiVersion.h:42
DtRtiAssistantLrcClient::myUdpInterface
MAKRti::DtInetAddr myUdpInterface
The address of the network interface being used for UDP.
Definition: rtiAssistantLrcClient.h:182
DtRtiAssistantLrcClient::myUseRtiexec
bool myUseRtiexec
Whether use of an rtiexec is enabled.
Definition: rtiAssistantLrcClient.h:191
DtRtiAssistantLrcClient::myLogFile
MAKRti::DtFilename myLogFile
The name and full path of the log file.
Definition: rtiAssistantLrcClient.h:165
DtRtiAssistantLrcClient::myTcpInterface
MAKRti::DtInetAddr myTcpInterface
The address of the network interface being used for UDP.
Definition: rtiAssistantLrcClient.h:176
DtRtiAssistantLrcClient::myUdpPort
int myUdpPort
The RTI UDP port.
Definition: rtiAssistantLrcClient.h:185
DT_DLL_ASSISTANT
#define DT_DLL_ASSISTANT
_WIN32
Definition: rtiMsConfig.h:121
DtRtiAssistantLrcClient::myName
MAKRti::DtString myName
The name the Assistant uses to identify this LRC.
Definition: rtiAssistantLrcClient.h:153
DtRtiAssistantLrcClient::myFederationHandle
unsigned long myFederationHandle
This LRC&#39;s federation handle.
Definition: rtiAssistantLrcClient.h:159
DtRtiAssistantLrcClient::myFederationName
MAKRti::DtString myFederationName
This LRC&#39;s federation name.
Definition: rtiAssistantLrcClient.h:162
DtRtiAssistantLrcClient::myFullCompliance
bool myFullCompliance
Whether full compliance is enabled.
Definition: rtiAssistantLrcClient.h:194
rtiAssistantClient.h
Contains the DtRtiAssistantClient class declaration.
DtAssistantHandleType
DtAssistantHandleType
Definition: assistantNetStatsEnums.h:23
DtRtiAssistantLrcClient::myFedHandle
unsigned long myFedHandle
This LRC&#39;s federate handle.
Definition: rtiAssistantLrcClient.h:156
DtRtiAssistantClient::sendClientInfo
virtual void sendClientInfo()
intended to be over-ridden by subclasses.
internalTypes.h
The declaration of internal types.
DtRtiAssistantLrcClient::myTcpPort
int myTcpPort
The RTI TCP port.
Definition: rtiAssistantLrcClient.h:188
DtRtiAssistantLrcClient::myForwarderPort
int myForwarderPort
The port the forwarder uses to connect to other forwarders.
Definition: rtiAssistantLrcClient.h:197
Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)