MAK Data Logger API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lgrHlaSimCommandFactory.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 1992-2016 VT MAK
3 ** All rights reserved.
4 ******************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <lgrCmds/lgrCmds.h>
13 #include <lgrCmds/lgrCommand.h>
14 #include <lgrUtil/collectors.h>
15 #include <lgrCmds/lgrSimCommandFactory.h>
16 
17 #include <utility>
18 #include <vlutil/vlString.h>
19 
20 namespace MAKLogger
21 {
22 
23  class DtCommandDefinition;
24  class DtLgrDisEntityTypeManager;
25 
28  class DT_DLL_LGR_CMDS DtLgrHlaCommandFactory : public DtLgrSimCommandFactory
29  {
30 
31  public:
32 
34  static DtLgrCommandType theCommandType;
35 
37  static const DtLgrCommandId theBaseCommandId = DtLgrSimCommandFactory::theLastCommandId;
38 
40 
41 
42  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 1, SetConnectionParametersHLA,
43  (const DtString& federateType, const DtString& federationName, const DtString& fedFile,
44  bool ignoreAdvisories, double fomVersion, int fomRevision, bool useMatrexFomMapper,
45  const DtString& matrexFomMapperData,
46  const DtString& fomMapper, const DtString& fomMapperData, bool useEmptyFomMapper, bool noRtiCompilerCheck),
47  (const DtCommand& command, DtString& federateName, DtString& federationName,
48  DtString& fedFile, bool& ignoreAdvisories, double& fomVersion, int& fomRevision,
49  bool& useMatrexFomMapper, DtString& matrexFomMapperData, DtString& fomMapper,
50  DtString& fomMapperData, bool& useEmptyFomMapper, bool& noRtiCompilerCheck))
51 
52  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 2, SetConnectionParametersHLAe,
53  (const DtString& federateName, const DtString& federateType, const DtString& federationName,
54  const DtString& fedFile, const std::vector<DtString>& fomModules, const DtString& mim,
55  bool ignoreAdvisories, double fomVersion, int fomRevision, bool useMatrexFomMapper,
56  const DtString& matrexFomMapperData, const DtString& fomMapper,
57  const DtString& fomMapperData, bool useEmptyFomMapper, bool noRtiCompilerCheck),
58  (const DtCommand& command, DtString& federateName, DtString& federateType,
59  DtString& federationName, DtString& fedFile, std::vector<DtString>& fomModules,
60  DtString& mim, bool& ignoreAdvisories, double& fomVersion, int& fomRevision,
61  bool& useMatrexFomMapper, DtString& matrexFomMapperData, DtString& fomMapper,
62  DtString& fomMapperData, bool& useEmptyFomMapper, bool& noRtiCompilerCheck))
63 
64  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 3, SetTimeManagement,
65  (bool timeConstrainedRecording, bool timeConstrainedPlayback, bool timeRegulatingRecording,
66  bool timeRegulatingPlayback, double lookahead),
67  (const DtCommand& command, bool& timeConstrainedRecording, bool& timeConstrainedPlayback,
68  bool& timeRegulatingRecording, bool& timeRegulatingPlayback, double& lookahead))
69 
70  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 4, SetIgnoreAdvisories,
71  (bool ignore),
72  (const DtCommand& command, bool& ignore))
73 
74  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 5, SetPassiveSubscription,
75  (bool passive),
76  (const DtCommand& command, bool& passive))
77 
78  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 6, LoadSubscriptionListFile,
79  (const DtString& filename),
80  (const DtCommand& command, DtString& filename))
81 
82  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 7, SaveSubscriptionListFile,
83  (const DtString& filename),
84  (const DtCommand& command, DtString& filename))
85 
86  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 8, SetSubscriptionLists,
87  (const std::vector<DtString>& objectClasses, const std::vector<DtString>& interactionClasses),
88  (const DtCommand& command, std::vector<DtString>& objectClasses,
89  std::vector<DtString>& interactionClasses))
90 
91  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 9, SetDisableTimeManagementTest,
92  (bool disableTesting),
93  (const DtCommand& command, bool& disableTesting))
94 
95  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 10, SetDynamicNamePrefix,
96  (const DtString& prefix),
97  (const DtCommand& command, DtString& prefix))
98 
99  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 11, LoadPublicationListFile,
100  (const DtString& filename),
101  (const DtCommand& command, DtString& filename))
102 
103  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 12, SetDrainInput,
104  (double maxTime, double minTime),
105  (const DtCommand& command, double& maxTime, double& minTime))
106 
107  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 13, SetDdmParameters,
108  (bool enableDdm, const DtString& playbackMode, const DtString& subscribeMode,
109  bool playbackDynamicAssociation, bool playbackDynamicExtents,
110  bool allowPlaybackWithoutRegions, bool recordConveyedRegions, bool requestUpdates,
111  bool subscribeUnspecifiedAttributes),
112  (const DtCommand& command, bool& enableDdm, DtString& playbackMode, DtString& subscribeMode,
113  bool& playbackDynamicAssociation, bool& playbackDynamicExtents,
114  bool& allowPlaybackWithoutRegions, bool& recordConveyedRegions, bool& requestUpdates,
115  bool& subscribeUnspecifiedAttributes))
116 
117  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 14, AddTrafficAnalyzerFilter,
118  (void* filter),
119  (const DtCommand& command, void*& filter))
120 
121  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 15, RemoveTrafficAnalyzerFilter,
122  (void* filter),
123  (const DtCommand& command, void*& filter))
124 
125  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 16, EnableTrafficAnalyzer,
126  (bool enable),
127  (const DtCommand& command, bool& enable))
128 
129  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 17, SetEntityTypeManager,
130  ( const DtBase64Data&),
131  ( const DtCommand& command, DtBase64Data&))
132 
133  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 18, SetCommonEntityTypes,
134  ( const std::vector<DtString>& types),
135  ( const DtCommand& command,std::vector<DtString>& types))
136 
137  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 19, FilterEntityTypes,
138  ( const std::vector<DtString>& types),
139  ( const DtCommand& command,std::vector<DtString>& types))
140 
141  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 20, FilterObjectNames,
142  ( const std::vector<DtString>& names),
143  ( const DtCommand& command,std::vector<DtString>& names))
144 
145  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 21, SetCommonObjectNames,
146  ( const std::vector<DtString>& names),
147  ( const DtCommand& command,std::vector<DtString>& names))
148 
149  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 22, SetFilterMomSubscription,
150  (bool enable),
151  (const DtCommand& command, bool& enable))
152 
153  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 23, SetRequestUpdates,
154  (bool enable),
155  (const DtCommand& command, bool& enable))
156 
157  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 24, SetSaveTrafficAnalyzerConfiguration,
158  (bool enable),
159  (const DtCommand& command, bool& enable))
160 
161  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 25, SetSendOnlyUpdatedValues,
162  (bool enable),
163  (const DtCommand& command, bool& enable))
164 
165  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 26, SetSiteApp,
166  (int site, int host),
167  (const DtCommand& command, int& site, int& host))
168 
170 
173  static const DtLgrCommandId theLastCommandId = theBaseCommandId + 100;
174 
176  static const DtLgrCommandId theBaseResponseId = DtLgrSimCommandFactory::theLastResponseId;
177 
179 
181  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 1,ConnectionParametersHLAChanged,
182  (const DtString& federateType, const DtString& federationName, const DtString& fedFile,
183  bool ignoreAdvisories, double fomVersion, int fomRevision, bool useMatrexFomMapper,
184  const DtString& matrexFomMapperData, const DtString& fomMapper,
185  const DtString& fomMapperData, bool useEmptyFomMapper, bool noRtiCompilerCheck),
186  (DtResponse response, DtString& federateType, DtString& federationName, DtString& fedFile,
187  bool& ignoreAdvisories, double& fomVersion, int& fomRevision, bool& useMatrexFomMapper,
188  DtString& matrexFomMapperData, DtString& fomMapper, DtString& fomMapperData,
189  bool& useEmptyFomMapper, bool& noRtiCompilerCheck))
190 
191  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 2,ConnectionParametersHLAeChanged,
192  (const DtString& federateName, const DtString& federateType, const DtString& federationName,
193  const DtString& fedFile, const std::vector<DtString>& fomModules, const DtString& mim,
194  bool ignoreAdvisories, double fomVersion, int fomRevision, bool useMatrexFomMapper,
195  const DtString& matrexFomMapperData, const DtString& fomMapper,
196  const DtString& fomMapperData, bool useEmptyFomMapper, bool noRtiCompilerCheck),
197  (DtResponse response, DtString& federateName, DtString& federateType,
198  DtString& federationName, DtString& fedFile, std::vector<DtString>& fomModules,
199  DtString& mim, bool& ignoreAdvisories, double& fomVersion, int& fomRevision,
200  bool& useMatrexFomMapper, DtString& matrexFomMapperData, DtString& fomMapper,
201  DtString& fomMapperData, bool& useEmptyFomMapper, bool& noRtiCompilerCheck))
202 
203  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 3,FomChanged,
204  (const DtBase64Data& data),
205  (DtResponse response, DtBase64Data& data))
206 
207  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 4,SubscriptionListsChanged,
208  (const std::vector<DtString>& objectClasses, const std::vector<DtString>& interactionClasses),
209  (DtResponse response, std::vector<DtString>& objectClasses,
210  std::vector<DtString>& interactionClasses))
211 
212  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 5,TimeManagementSettingsChanged,
213  (bool timeConstrainedRecording, bool timeConstrainedPlayback, bool timeRegulatingRecording,
214  bool timeRegulatingPlayback, double lookahead),
215  (DtResponse response, bool& timeConstrainedRecording, bool& timeConstrainedPlayback,
216  bool& timeRegulatingRecording, bool& timeRegulatingPlayback, double& lookahead))
217 
218  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 6,TimeManagementEnabled,
219  (bool enabled,bool constrained,bool regulating),
220  (DtResponse response, bool& enabled, bool& constrained, bool& regulating))
221 
222  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 7,DrainInputSettingsChanged,
223  (double maxTime, double minTime),
224  (DtResponse response, double& maxTime, double& minTime))
225 
226  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 8,DdmParameterSettingsChanged,
227  (bool enableDdm, const DtString& playbackMode, const DtString& subscribeMode,
228  bool playbackDynamicAssociation, bool playbackDynamicExtents,
229  bool allowPlaybackWithoutRegions, bool recordConveyedRegions, bool requestUpdates,
230  bool subscribeUnspecifiedAttributes),
231  (DtResponse response, bool& enableDdm, DtString& playbackMode, DtString& subscribeMode,
232  bool& playbackDynamicAssociation, bool& playbackDynamicExtents,
233  bool& allowPlaybackWithoutRegions, bool& recordConveyedRegions, bool& requestUpdates,
234  bool& subscribeUnspecifiedAttributes))
235 
236  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 9,IgnoreAdvisoriesChanged,
237  (bool enabled),
238  (DtResponse response, bool& enabled))
239 
240  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 10,TrafficAnalyzerChanged,
241  (bool enabled),
242  (DtResponse response, bool& enabled))
243 
244  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 11,EntityTypeManagerChanged,
245  (const DtBase64Data& mgr),
246  (DtResponse command, DtBase64Data& mgr))
247 
248 
249  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 12,EntityIdFilterChanged,
250  (DtBase64Data& filter),
251  (DtResponse command, DtBase64Data& filter))
252 
253  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 13,RequestUpdatesChanged,
254  (bool enabled),
255  (DtResponse response, bool& enabled))
256 
257  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 14,SaveTrafficAnalyzerConfigurationChanged,
258  (bool enabled),
259  (DtResponse response, bool& enabled))
260 
261  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 15,SendOnlyUpdatedValuesChanged,
262  (bool enabled),
263  (DtResponse response, bool& enabled))
264 
265  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 16,PassiveSubscriptionChanged,
266  (bool enabled),
267  (DtResponse response, bool& enabled))
268 
269  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 17,SiteAppChanged,
270  (int site, int host),
271  (DtResponse response, int& site, int& host))
272 
274 
277  static const DtLgrCommandId theLastResponseId = theBaseResponseId - 100;
278 
280  static const char* commandToString(int commandId);
281 
283  static const char* responseToString(int responseId);
284 
286  static DtResponse createConnectedResponse();
288  static DtResponse createDisconnectedResponse();
289  static DtResponse createLostConnectionResponse(const DtString& reason);
290  static DtResponse createUnableToConnectResponse(const DtString& reason);
292 
293  };
294 
295 }
MAKLogger::DtCommand
The logger command which contains the command type and its parameters.
Definition: lgrCommand.h:109
MAKLogger::DtLgrCommandType
The command type structure.
Definition: lgrCommand.h:29
MAKLogger::DtLgrHlaCommandFactory
Factory for create HLA simulation commands.
Definition: lgrHlaSimCommandFactory.h:28
DT_FACTORY_COMMAND_EXT
#define DT_FACTORY_COMMAND_EXT(commandId, commandName, createParams, decodeParams)
Utility Macros for declaring Command in Factory.
Definition: lgrCommand.h:183
MAKLogger::DtBase64Data
Utility class to encoding and decoding binary data to base64 string suitable for storing in text file...
Definition: base64Data.h:21
lgrSimCommandFactory.h
Contains MAKLogger::DtLgrSimCommandFactory class.
DT_DLL_LGR_CMDS
#define DT_DLL_LGR_CMDS
Definition: lgrCmds.h:18
MAKLogger::DtResponse
DtBoost::shared_ptr< const DtCommand > DtResponse
Definition: lgrCommand.h:174
MAKLogger::DtLgrHlaCommandFactory::theCommandType
static DtLgrCommandType theCommandType
The command type for all HLA Simulation commands from this factory.
Definition: lgrHlaSimCommandFactory.h:34
lgrCommand.h
Contains MAKLogger::DtLgrCommandType and MAKLogger::DtCommand classes.
DT_FACTORY_RESPONSE_EXT
#define DT_FACTORY_RESPONSE_EXT(responseId, responseName, createParams, decodeParams)
Utility Macros for declaring Response in Factory.
Definition: lgrCommand.h:198
lgrCmds.h
Contains lgrCmds library definitions.
MAKLogger::DtLgrSimCommandFactory
The factory responsible for creating simulation commands.
Definition: lgrSimCommandFactory.h:21
MAKLogger::DtLgrCommandId
short DtLgrCommandId
Definition: lgrCommand.h:25
MAKLogger::DtLgrSimCommandFactory::theLastCommandId
const DtCommand bool bool bool bool bool bool bool bool double double const DtCommand bool bool bool bool bool bool bool bool double double &heartbeatSendInterval bool const DtCommand bool &scale DtExerciseConn bool bool bool const DtCommand DtExerciseConn bool bool bool &allowUnsubscribe const DtString const DtCommand DtString &name const DtString const DtCommand DtString &intervals const DtString const DtCommand DtString &name bool const DtCommand bool &playbackfilesUseRandomAccess double const DtCommand double &extendedStopTimeoutInterval bool const DtCommand bool &adjustSimTime bool const DtCommand bool &saveProtocolConfiguration const std::vector< DtString > const DtCommand std::vector< DtString > &static markings const DtLgrCommandId theLastCommandId
Last command ID, all IDs in this class must be &lt;= Command IDs in derived classes must be &gt; ...
Definition: lgrSimCommandFactory.h:141
Document ID: Generated on Mon Mar 22 15:30:17 EDT 2021 from SVN revision 226440
Copyright © 2021 MAK Technologies. All Rights Reserved (www.mak.com)