VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
exerciseConnInitializerHLA.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2017 VT MAK
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #if DtHLA
13 
14 #include <vlutil/vlString.h>
15 
17 #include <mtl/configVariable.h>
19 
20 
21 #include <cmdLine/cmdLine.h>
22 #include "fomMapper.h"
23 
24 class DtMtlEnvironment;
25 
26 
27 #if defined (DtHLA_1516_EVOLVED)
28 #define DtDefaultRpr2Fom "RPR_FOM_v2.0_1516-2010.xml"
29 #define DtDefaultRpr1Fom "MAK-RPR1-1-6_evolved.xml"
30 #elif defined(DtHLA_1516)
31 #define DtDefaultRpr2Fom "MAK-RPR2-1-6.xml"
32 #define DtDefaultRpr1Fom "MAK-RPR1-1-6.xml"
33 #else //HLA 1.3
34 #define DtDefaultRpr2Fom "MAK-RPR2-1-6.fed"
35 #define DtDefaultRpr1Fom "MAK-RPR1-1-6.fed"
36 #endif
37 
42 {
43 public:
44 
48  {
51  DtGetValuePointerWhereAvailable
52  };
53 
54 public:
57 
59  virtual ~DtExerciseConnInitializer();
60 
63 
66 
68  virtual DtString execName() const;
69 
71  virtual void setExecName(const DtString& name);
72 
75  virtual DtString federateName() const;
76 
79  virtual void setFederateName(const DtString& name);
80 
82  virtual DtString federateType() const;
83 
86  virtual void setFederateType(const DtString& type);
87 
89  virtual DtString fedFileName() const;
90 
92  virtual void setFedFileName(const DtString& name);
93 
95  virtual DtFomMapper* fomMapper() const;
96 
98  virtual void setFomMapper(DtFomMapper* mapper);
99 
102  virtual DtString fomMapperLibName() const;
103 
105  virtual void setFomMapperLibName(const DtString& name);
106 
108  virtual void* fomMapperInitData() const;
109 
111  virtual void setFomMapperInitData(void* data);
112 
119  virtual void setRprFomVersion(double version);
120 
122  virtual double rprFomVersion() const;
123 
126  virtual void setReflecting(bool onOff);
127 
129  virtual bool reflecting() const;
130 
133  virtual void setPassiveMode(bool onOff);
134 
136  virtual bool passiveMode() const;
137 
151  virtual void setReflectRemoteUpdatesIntoPub(bool onOff);
152 
154  virtual bool reflectRemoteUpdatesIntoPub() const;
155 
162  virtual void setReflectThroughRti(bool onOff);
163 
165  virtual bool reflectThroughRti() const;
166 
174  virtual void setUseAdvisories(bool onOff);
175 
177  virtual bool useAdvisories() const;
178 
184  virtual void setReplyToSynchPoints(bool onOff);
185 
187  virtual bool replyToSynchPoints() const;
188 
194  virtual void setAutoSubscribe(bool onOff);
195 
197  virtual bool autoSubscribe() const;
198 
202  virtual void setTimeStampType(DtTimeStampType relOrAbs);
203 
205  virtual DtTimeStampType timeStampType() const;
206 
212  virtual void setDestroyFedExec(bool onOff);
213 
215  virtual bool destroyFedExec() const;
216 
221  virtual void setSendFedTime(bool onOff);
222 
224  virtual bool sendFedTime() const;
225 
227  virtual void setNotifyLevel(int level);
228 
230  virtual void setUseGeographicDdm(bool yesNo);
231 
233  virtual bool useGeographicDdm() const;
234 
240  virtual void setRprFomRevision(int val);
243  virtual int rprFomRevision() const;
244 
250  virtual void setExceptionOnRtiCompilerMismatch( bool useException );
251 
252  virtual bool exceptionOnRtiCompilerMismatch() const;
253 
265 
266  virtual void setGetValueMethod( DtGetValueMethod getValueMethodChoice );
267  virtual DtGetValueMethod getValueMethod( ) const;
269 
275 
276  virtual void setGenericAttributes(bool yesNo);
277  virtual bool enabledGenericAttributes() const;
279 
280 
282 
283  virtual bool pauseOnSaveRestore() const;
284  virtual void setPauseOnSaveRestore(bool yesNo);
286 
287 #if DtHLA_1516_EVOLVED
288 
290  virtual void setMimModule(const DtString& mimFomModule);
292  virtual DtString mimModule() const;
293 
295  virtual void addFomModule(const DtString& module);
297  virtual void setFomModules(const std::vector<DtString>& fomModules);
298 
300  virtual void fomModules(std::vector<DtString>& fomModules) const;
302  virtual void fomModules(std::vector<std::wstring>& fomModules) const;
303 
305  virtual void setLocalSettingsDesignator( const std::wstring & localSettingsDesignator );
307  virtual void setLocalSettingsDesignator( const DtString & localSettingsDesignator );
309  virtual std::wstring localSettingsDesignator() const;
310 
311 #elif DtHLA_1516
312 
314  virtual void setRtiArguments(const std::vector<std::wstring>& args);
315 
317  virtual void setRtiArguments(const std::vector<DtString>& args);
318 
320  virtual void rtiArguments(std::vector<std::wstring>& args) const;
321 
322 #endif
323 
324 public:
325 
327  static DtString vrlinkVersion();
328 
331 private:
355 
356 
357 #if DtHLA_1516_EVOLVED
358  std::wstring myLocalSettingsDesignator;
359 #elif DtHLA_1516
360  std::vector<std::wstring> myRtiArguments;
361 #endif
362 
366 
369  std::vector<DtString> myFomModules;
370 
372 
373 };
374 
387 {
388 public:
390  DtVrlApplicationInitializer(int argc, char* argv[], const DtString& appName,
392 #ifdef _WIN32
393  bool pressAnyKey = true);
394 #else
395  bool pressAnyKey = false);
396 #endif
397 
399  virtual ~DtVrlApplicationInitializer();
400 
402  virtual int argc() const;
403 
405  virtual char** argv() const;
406 
411  virtual void parseCmdLine();
412 
416  virtual void loadFile(const DtString& fileName);
417  virtual void loadMtlFile(const DtString& fileName);
418 
420  virtual void saveFile(const DtString& filename);
421 
422  //{@
424  virtual void setExecName(const DtString& name);
425  virtual DtString execName() const;
427 
428  //{@
431  virtual void setFederateName(const DtString& name);
432  virtual DtString federateName() const;
434 
435 #if DtHLA_1516_EVOLVED
436  //{@
439  virtual void setLocalSettingsDesignator(const DtString& name);
440  virtual std::wstring localSettingsDesignator() const;
441 
444  virtual void setMimModule(const DtString& mimFomModule);
445  virtual DtString mimModule() const;
447 #endif
448 
449  //{@
451  virtual void setNotifyFileLevel(int level);
452  virtual int notifyFileLevel() const;
454 
455  //{@
457  virtual void setNotifyFilename(const DtString& file);
458  virtual DtString notifyFilename() const;
460 
461  //{@
463  virtual void setFederateType(const DtString& type);
464  virtual DtString federateType() const;
466 
467  //{@
469  void setFedFileName(const DtString& name);
470  virtual DtString fedFileName() const;
472 
473  //{@
475  virtual void setFomMapperLibName(const DtString& name);
476  virtual DtString fomMapperLibName() const;
478 
479  //{@
481  virtual void setRprFomVersion(double version);
482  virtual double rprFomVersion() const;
484 
485  //{@
487  virtual void* fomMapperInitData() const;
488  virtual void setFomMapperInitData(void* data);
490 
491  virtual void setUseAdvisories(bool onOff);
492 
493  virtual bool useAdvisories() const;
494 
498  virtual void setTimeStampType(DtTimeStampType relOrAbs);
499 
501  virtual DtTimeStampType timeStampType() const;
502 
508  virtual void setDestroyFedExec(bool onOff);
509 
511  virtual bool destroyFedExec() const;
512 
517  virtual void setSendFedTime(bool onOff);
518 
520  virtual bool sendFedTime() const;
521 
522  virtual void setUseGeographicDdm(bool yesNo);
523 
524  virtual bool useGeographicDdm() const;
525 
526  virtual void setRprFomRevision(int val);
527  virtual int rprFomRevision() const;
528 
534  virtual void setGenericAttributes(bool yesNo);
535  virtual bool enabledGenericAttributes() const;
536 
538 
539  virtual bool pauseOnSaveRestore() const;
540  virtual void setPauseOnSaveRestore(bool yesNo);
541 
542  virtual void setExceptionOnRtiCompilerMismatch(bool yesNo);
543  virtual bool exceptionOnRtiCompilerMismatch() const;
545 
546 protected:
548  virtual void initializeFileLogging();
549 
550 protected:
551  int myArgc;
552  char** myArgv;
554 
555  virtual void initializeMtlParams();
556 
564 #if DtHLA_1516_EVOLVED
565  DtMultiConfigVariable<DtString> myConfigVarFomModules;
566  DtConfigVariable<DtString> myConfigVarMimModule;
567  DtConfigVariable<DtString> myConfigVarLocalSettingsDesignator;
568 #endif
584 
585  // If logging is turned on, this printer will remain in memory
586  // even after this class is destroyed. Otherwise we would
587  // have to stop logging prematurely.
589 
596 };
597 
598 #endif // DtHLA
DtConfigVariable< bool > myConfigVarPauseOnSaveRestore
Definition: exerciseConnInitializerHLA.h:580
command line support
Definition: mtlEnvironment.h:42
virtual void setDestroyFedExec(bool onOff)
Set the destroy fed exec flag.
DtConfigVariable< double > myConfigVarRprFomVersion
Definition: exerciseConnInitializerHLA.h:571
Contains the DtApplicationSettings class declaration.
virtual bool sendFedTime() const
Get the send fed time flag. See above description.
DtConfigVariable< bool > myConfigVarUseAbsoluteTimestamps
Definition: exerciseConnInitializerHLA.h:576
virtual void setFomMapperLibName(const DtString &name)
Get the FOM Mapper library name.
Definition: applicationSettings.h:24
bool myReplyToSynchPoints
Definition: exerciseConnInitializerHLA.h:342
virtual bool enabledGenericAttributes() const
Set the Generic attributes flag.
virtual bool destroyFedExec() const
Get the destroy fed exec flag. See above description.
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
bool myPassiveMode
Definition: exerciseConnInitializerHLA.h:340
DtConfigVariable< bool > myConfigVarRtiCompilerCheck
Definition: exerciseConnInitializerHLA.h:581
Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization dat...
Definition: exerciseConnInitializerHLA.h:41
Contains the DtString class declaration.
bool myReflectRemoteUpdatesIntoPub
Definition: exerciseConnInitializerHLA.h:344
DtFilePrinter is a subclass of DtPrinter which opens a file and dumps all information received from D...
Definition: vlPrint.h:80
DtString myMimModule
Definition: exerciseConnInitializerHLA.h:371
int myMtlSendFedTime
Definition: exerciseConnInitializerHLA.h:594
char ** myArgv
Definition: exerciseConnInitializerHLA.h:552
int myRprFomRevision
Definition: exerciseConnInitializerHLA.h:352
DtTimeStampType myTimeStampType
Definition: exerciseConnInitializerHLA.h:346
virtual void * fomMapperInitData() const
Set the FOM mapper initialization data.
int myMtlUseGeographicDdm
Definition: exerciseConnInitializerHLA.h:591
int myMtlUseAbsoluteTimeStamps
Definition: exerciseConnInitializerHLA.h:592
bool myExceptionOnRtiCompilerMismatch
Definition: exerciseConnInitializerHLA.h:353
void * myFomMapperInitData
Definition: exerciseConnInitializerHLA.h:337
virtual int rprFomRevision() const
returns the revision of the current FOM being used.
virtual DtString federateType() const
Get the federate type.
DtConfigVariable< DtString > myConfigVarFederateType
Definition: exerciseConnInitializerHLA.h:560
This file declares DtFomMapper.
bool myReflecting
Definition: exerciseConnInitializerHLA.h:339
DtConfigVariable< int > myConfigVarNotifyFileLevel
Definition: exerciseConnInitializerHLA.h:582
static DtString vrlinkVersion()
Returns a string indicating the VR-Link version number.
virtual DtTimeStampType timeStampType() const
Get the time stamp type.
DtString myFederateType
Definition: exerciseConnInitializerHLA.h:333
virtual bool exceptionOnRtiCompilerMismatch() const
Contains the DtMultiConfigVariable class declaration.
DtString myFomMapperLibName
Definition: exerciseConnInitializerHLA.h:336
DtGetValueMethod myGetValueMethod
Definition: exerciseConnInitializerHLA.h:354
DtFomMapper * myFomMapper
Definition: exerciseConnInitializerHLA.h:335
double myRprFomVersion
Definition: exerciseConnInitializerHLA.h:338
DtConfigVariable< bool > myConfigVarUseGeographicDdm
Definition: exerciseConnInitializerHLA.h:575
virtual void setRprFomVersion(double version)
Set the RPR FOM Version.
virtual void setGenericAttributes(bool yesNo)
Set the Generic attributes flag.
virtual DtString fedFileName() const
Set the fed file name.
std::vector< DtString > myFomModules
myFomModules represents the set of FOM Modules to be used to establish the Object Model of the Federa...
Definition: exerciseConnInitializerHLA.h:369
bool myAutoSubscribe
Definition: exerciseConnInitializerHLA.h:343
bool myReflectThroughRti
Definition: exerciseConnInitializerHLA.h:345
virtual DtString federateName() const
Set the federate name In HLA Evolved, this is the same as federateType.
DtConfigVariable< int > myConfigVarNotifyLevel
Definition: exerciseConnInitializerHLA.h:558
virtual bool useGeographicDdm() const
Get the use geographic DDM flag.
Contains the DtConfigVariable class declaration.
DtConfigVariable< DtString > myConfigVarFomMapperInitData
Definition: exerciseConnInitializerHLA.h:570
DtMtlEnvironment * myMtlEnv
Definition: exerciseConnInitializerHLA.h:553
DtConfigVariable< int > myConfigVarRprFomRevision
Definition: exerciseConnInitializerHLA.h:572
Instances of DtVrlApplicationInitializer are used to initialize the exercise connection with command ...
Definition: exerciseConnInitializerHLA.h:386
virtual void setUseGeographicDdm(bool yesNo)
Sets the use geographic DDM flag.
virtual void setFedFileName(const DtString &name)
Get the fed file name.
bool mySendFedTime
Definition: exerciseConnInitializerHLA.h:348
DtString myFedFileName
The following two variables are different representations of the same concept.
Definition: exerciseConnInitializerHLA.h:365
DtConfigVariable< bool > myConfigVarSendFedTime
Definition: exerciseConnInitializerHLA.h:578
DtApplicationSettings mySettings
Definition: exerciseConnInitializerHLA.h:557
DtString myFederateName
Definition: exerciseConnInitializerHLA.h:334
Definition: exerciseConnInitializerHLA.h:50
This file declares the class DtCmdLine::CmdLine.
virtual DtString fomMapperLibName() const
Set the FOM Mapper library name.
DtConfigVariable< DtString > myConfigVarExecName
Definition: exerciseConnInitializerHLA.h:561
DtConfigVariable< DtString > myConfigVarNotifyFilename
Definition: exerciseConnInitializerHLA.h:583
virtual void setUseAdvisories(bool onOff)
Set use of advisories.
bool myPauseOnSaveRestore
Definition: exerciseConnInitializerHLA.h:349
DtConfigVariable< bool > myConfigVarDestroyFedExec
Definition: exerciseConnInitializerHLA.h:577
DtConfigVariable< DtString > myConfigVarFomMapperLibName
Definition: exerciseConnInitializerHLA.h:569
DtConfigVariable< bool > myConfigVarGenericAttributes
Definition: exerciseConnInitializerHLA.h:579
Definition: exerciseConnInitializerHLA.h:49
DtVariableGroup myHlaConnection
Definition: exerciseConnInitializerHLA.h:559
bool myUseGeographicDdm
Definition: exerciseConnInitializerHLA.h:351
virtual void setFederateName(const DtString &name)
Set the federate name In HLA Evolved, this is the same as setFederateType.
int myMtlDestroyFedExec
Definition: exerciseConnInitializerHLA.h:593
virtual bool useAdvisories() const
Get use of advisories.
virtual void setTimeStampType(DtTimeStampType relOrAbs)
Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).
bool myUseAdvisories
Definition: exerciseConnInitializerHLA.h:341
Represents a group of variables.
Definition: variableGroup.h:21
virtual void setRprFomRevision(int val)
Sets the revision of the FOM Mapper currently used.
virtual double rprFomVersion() const
Returns the RPR FOM Version. See above description.
DtTimeStampType
Definition: vlTimeStampType.h:16
int myMtlUseAdvisories
Definition: exerciseConnInitializerHLA.h:590
bool myGenericAttributes
Definition: exerciseConnInitializerHLA.h:350
int myArgc
Definition: exerciseConnInitializerHLA.h:551
bool myDestroyFedExec
Definition: exerciseConnInitializerHLA.h:347
DtConfigVariable< DtString > myConfigVarFederateName
Definition: exerciseConnInitializerHLA.h:563
DtConfigVariable< bool > myConfigVarUseAdvisories
Definition: exerciseConnInitializerHLA.h:573
DtConfigVariable< bool > myConfigVarIgnoreAdvisories
Definition: exerciseConnInitializerHLA.h:574
Instances of DtString are used to represent strings.
Definition: vlString.h:29
DtFilePrinter * myLogFilePrinter
Definition: exerciseConnInitializerHLA.h:588
virtual void setExceptionOnRtiCompilerMismatch(bool useException)
Set whether DtExerciseConn throws an exception when detecting a mismatched RTI compiler version...
Instances of DtFomMapper are used to provide FOM agility in VR-Link by mapping VR-Link classes and fu...
Definition: fomMapper.h:36
virtual void setSendFedTime(bool onOff)
Set the send fed time flag.
virtual void setFomMapperInitData(void *data)
Get the FOM mapper initialization data.
virtual void setPauseOnSaveRestore(bool yesNo)
Block the simulation if a save or a restore is in process.
virtual DtString execName() const
Set the execution name.
DtConfigVariable< DtString > myConfigVarFedFileName
Definition: exerciseConnInitializerHLA.h:562
int myMtlPauseOnSaveRestore
Definition: exerciseConnInitializerHLA.h:595
virtual void setFederateType(const DtString &type)
Set the federate type.
virtual bool pauseOnSaveRestore() const
Block the simulation if a save or a restore is in process.
DtString myExecName
These values are private, because derived classes will be providing types of the same functionality...
Definition: exerciseConnInitializerHLA.h:332
Definition: multiConfigVariable.h:23
DtGetValueMethod
Indicate if getValue or getValuePointer should be used to retrieve data from handleValuePairSets.
Definition: exerciseConnInitializerHLA.h:47
virtual void setExecName(const DtString &name)
Get the execution name.

Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)