![]() |
VR-Link API Documentation for HLA 1.3
|
Instances of DtVrlApplicationInitializer are used to initialize the exercise connection with command line arguments. More...
Inheritance diagram for DtVrlApplicationInitializer:
Collaboration diagram for DtVrlApplicationInitializer:Public Member Functions | |
| DtVrlApplicationInitializer (int argc, char *argv[], const DtString &appName, const DtString &defaultConfigFilePath=DtDefaultConfigFile, const DtString &version=DtExerciseConnInitializer::vrlinkVersion(), bool pressAnyKey=false) | |
| Constructor. More... | |
| virtual | ~DtVrlApplicationInitializer () |
| Destructor. More... | |
| DtVrlApplicationInitializer (const DtVrlApplicationInitializer &orig) | |
| Copy Constructor. More... | |
| DtVrlApplicationInitializer & | operator= (const DtVrlApplicationInitializer &orig) |
| Assignment Operator. More... | |
| virtual int | argc () const |
| Get the argc passed into the constructor. More... | |
| virtual char ** | argv () const |
| Get the argv passed into the constructor. More... | |
| virtual DtExerciseConnConfig * | exerciseConnectionConfig () |
| Get the exercise connection configuration. More... | |
| virtual const DtExerciseConnConfig & | exConnConfig () const |
| Get the exercise connection configuration. More... | |
| virtual DtApplicationSettings & | settings () |
| Get the application settings. More... | |
| virtual const int | disVersion () const |
| Get the disVersion. More... | |
| virtual void | parseCmdLine () |
| Parse the command line. More... | |
| virtual void | loadFile (const DtString &fileName) |
| Load a .mtl or .xml file. More... | |
| virtual void | saveFile (const DtString &filename) |
| Save configuration settings to a .xml file. More... | |
| virtual void | setExecName (const DtString &name) |
| Set/Get the federation execution name. More... | |
| virtual DtString | execName () const |
| Set the federation execution name. More... | |
| virtual void | setFederateName (const DtString &name) |
| HLA Evolved only. More... | |
| virtual DtString | federateName () const |
| Set the federate name In HLA Evolved, this is the same as federateType. More... | |
| virtual void | setNotifyFileLevel (int level) |
| Sets the notify level for file output, if the filename has been set. More... | |
| virtual int | notifyFileLevel () const |
| virtual void | setNotifyFilename (const DtString &file) |
| Setting this will allow notifications to be sent to a file as well as the console. More... | |
| virtual DtString | notifyFilename () const |
| virtual void | setFederateType (const DtString &type) |
| Set/Get the federate type. More... | |
| virtual DtString | federateType () const |
| Get the federate type. More... | |
| void | setFedFileName (const DtString &name) |
| Set/Get the fed file name. More... | |
| virtual DtString | fedFileName () const |
| Set the fed file name. More... | |
| virtual void | setSiteId (int id) |
| Set/Get the site number/id. More... | |
| virtual int | siteId () const |
| virtual void | setApplicationNumber (int num) |
| Set/Get the application number. More... | |
| virtual int | applicationNumber () const |
| virtual void | setFomMapperLibName (const DtString &name) |
| Set/Get the DSO name. More... | |
| virtual DtString | fomMapperLibName () const |
| Set the FOM Mapper library name. More... | |
| virtual void | setRprFomVersion (double version) |
| Set/Get the RPR FOM Version. More... | |
| virtual double | rprFomVersion () const |
| Returns the RPR FOM Version. See above description. More... | |
| virtual void | setNetnFomVersion (double version) |
| Set/Get the NETN FOM Version. More... | |
| virtual double | netnFomVersion () const |
| Returns the NETN FOM Version. See above description. More... | |
| virtual void * | fomMapperInitData () const |
| Set/Get the FOM mapper initialization data. More... | |
| virtual void | setFomMapperInitData (void *data) |
| Get the FOM mapper initialization data. More... | |
| virtual void | setUseAdvisories (bool onOff) |
| Set/Get the whether to use advisories. More... | |
| virtual bool | useAdvisories () const |
| Get use of advisories. More... | |
| virtual void | setUseDis5Timestamps (bool onOff) |
| Set/Get the whether to use DIS 5 timestamps. More... | |
| virtual bool | useDis5TimeStamps () const |
| virtual void | setRequestClassUpdate (bool onOff) |
| Set/Get request class update flag. More... | |
| virtual bool | requestClassUpdate () const |
| Get request class update flag. More... | |
| virtual void | setRequestObjectUpdate (bool onOff) |
| Set/Get request object update flag. More... | |
| virtual bool | requestObjectUpdate () const |
| Get request object update flag. More... | |
| virtual void | setRequestWhenInitialized (bool onOff) |
| Set/Get request when initialized flag. More... | |
| virtual bool | requestWhenInitialized () const |
| Get request when initialized flag. More... | |
| virtual void | setDefaultRefreshWaitList (bool onOff) |
| Set/Get request object update flag. More... | |
| virtual bool | defaultRefreshWaitList () const |
| Get request object update flag. More... | |
| virtual void | setDefaultWaitListRefreshPeriod (double period) |
| Set/Get default wait list refresh period. More... | |
| virtual double | defaultWaitListRefreshPeriod () const |
| Get default wait list refresh period. More... | |
| virtual void | setTimeStampType (DtTimeStampType relOrAbs) |
| Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative). More... | |
| virtual DtTimeStampType | timeStampType () const |
| Get the time stamp type. More... | |
| virtual void | setDestroyFedExec (bool onOff) |
| Set the destroy fed exec flag. More... | |
| virtual bool | destroyFedExec () const |
| Get the destroy fed exec flag. See above description. More... | |
| virtual void | setSendFedTime (bool onOff) |
| Set the send fed time flag. More... | |
| virtual bool | sendFedTime () const |
| Get the send fed time flag. See above description. More... | |
| virtual void | setUseGeographicDdm (bool yesNo) |
| Sets the use geographic DDM flag. More... | |
| virtual bool | useGeographicDdm () const |
| Get the use geographic DDM flag. More... | |
| virtual void | setRprFomRevision (int val) |
| Set the RPR FOM Revision to an integer. More... | |
| virtual int | rprFomRevision () const |
| Return the RPR FOM revision as an integer. More... | |
| virtual void | setNetnFomRevision (int val) |
| Set the NETN FOM Revision to an integer. More... | |
| virtual int | netnFomRevision () const |
| Return the NETN FOM revision as an integer. More... | |
| virtual void | setGenericAttributes (bool yesNo) |
| Set the Generic attributes flag. More... | |
| virtual bool | enabledGenericAttributes () const |
| Set the Generic attributes flag. More... | |
| virtual void | setOutputInterval (double period) |
| Set print output interval. More... | |
| virtual double | outputInterval () const |
| Get print output interval. More... | |
| virtual bool | pauseOnSaveRestore () const |
| Block the simulation if a save or a restore is in process. More... | |
| virtual void | setPauseOnSaveRestore (bool yesNo) |
| Block the simulation if a save or a restore is in process. More... | |
| virtual void | setExceptionOnRtiCompilerMismatch (bool yesNo) |
| Block the simulation if a save or a restore is in process. More... | |
| virtual bool | exceptionOnRtiCompilerMismatch () const |
| Block the simulation if a save or a restore is in process. More... | |
Public Member Functions inherited from DtExerciseConnInitializer | |
| DtExerciseConnInitializer () | |
| Constructor. More... | |
| virtual | ~DtExerciseConnInitializer () |
| Destructor. More... | |
| DtExerciseConnInitializer (const DtExerciseConnInitializer &orig) | |
| Copy Constructor. More... | |
| DtExerciseConnInitializer & | operator= (const DtExerciseConnInitializer &orig) |
| Assignment Operator. More... | |
| virtual DtFomMapper * | fomMapper () const |
| Set the FOM mapper. More... | |
| virtual void | setFomMapper (DtFomMapper *mapper) |
| Get the FOM mapper. More... | |
| virtual void | setReflecting (bool onOff) |
| Set reflecting. More... | |
| virtual bool | reflecting () const |
| Get reflecting. See above description. More... | |
| virtual void | setPassiveMode (bool onOff) |
| Set passive mode. More... | |
| virtual bool | passiveMode () const |
| Get passive mode. See above description. More... | |
| virtual void | setReflectRemoteUpdatesIntoPub (bool onOff) |
| Set the reflectRemoteUpdatesIntoPub flag. More... | |
| virtual bool | reflectRemoteUpdatesIntoPub () const |
| Get reflect remove updates into publisher flag. More... | |
| virtual void | setReflectThroughRti (bool onOff) |
| Set the reflecting through RTI flag to true. More... | |
| virtual bool | reflectThroughRti () const |
| Get the reflecting through RTI flag. More... | |
| virtual void | setReplyToSynchPoints (bool onOff) |
| Set reply to sync points. More... | |
| virtual bool | replyToSynchPoints () const |
| Get reply to sync points. See above description. More... | |
| virtual void | setAutoSubscribe (bool onOff) |
| Set auto subscribe flag. More... | |
| virtual bool | autoSubscribe () const |
| Get auto subscribe flag;. More... | |
| virtual bool | dis5Timestamps () const |
| Returns myDis5Timestamps setting. More... | |
| virtual void | setDis5Timestamps (bool onOff) |
| sets the myDis5Timestamps variable More... | |
| virtual void | setNotifyLevel (int level) |
| Sets the notify level. More... | |
| virtual void | setGetValueMethod (DtGetValueMethod getValueMethodChoice) |
| Configure how VR-Link retrieves data from RTI attribute/parameter handle value pair sets. More... | |
| virtual DtGetValueMethod | getValueMethod () const |
| Configure how VR-Link retrieves data from RTI attribute/parameter handle value pair sets. More... | |
Protected Member Functions | |
| virtual void | initializeFileLogging () |
| Start file logging. Done automatically by the reader. More... | |
| virtual void | initializeConnectionConfigVariables () |
| Initialize Config Variables with names and shortcuts. More... | |
| virtual void | initializeMtlParams () |
| Initialize the MTL parameters before loading a configuration file. More... | |
| virtual void | loadMtlFile (const DtString &fileName) |
| Used to load configuration when configuration file is MTL. More... | |
Additional Inherited Members | |
Public Types inherited from DtExerciseConnInitializer | |
| enum | DtGetValueMethod { DtForceGetValue, DtForceGetValuePointer, DtGetValuePointerWhereAvailable } |
| Indicate if getValue or getValuePointer should be used to retrieve data from handleValuePairSets. More... | |
Static Public Member Functions inherited from DtExerciseConnInitializer | |
| static DtString | vrlinkVersion () |
| Returns a string indicating the VR-Link version number. More... | |
Instances of DtVrlApplicationInitializer are used to initialize the exercise connection with command line arguments.
DtVrlApplicationInitializer is a subclass of DtExerciseConnInitializer. It provides all the functionality of DtExerciseConnInitializer, with the capability to provide command line arguments that are used to initialize the federate
| DtVrlApplicationInitializer::DtVrlApplicationInitializer | ( | int | argc, |
| char * | argv[], | ||
| const DtString & | appName, | ||
| const DtString & | defaultConfigFilePath = DtDefaultConfigFile, |
||
| const DtString & | version = DtExerciseConnInitializer::vrlinkVersion(), |
||
| bool | pressAnyKey = false |
||
| ) |
Constructor.
|
virtual |
Destructor.
| DtVrlApplicationInitializer::DtVrlApplicationInitializer | ( | const DtVrlApplicationInitializer & | orig | ) |
Copy Constructor.
|
virtual |
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the argc passed into the constructor.
|
virtual |
Get the argv passed into the constructor.
|
virtual |
Get request object update flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get default wait list refresh period.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the destroy fed exec flag. See above description.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the disVersion.
|
virtual |
Set the Generic attributes flag.
Generic Attributes enables the ability to encode and decode all attributes, even the ones that VR-Link does not understand. Those attributes' bytes are accessible through the state repository.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Block the simulation if a save or a restore is in process.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the exercise connection configuration.
|
virtual |
Set the federation execution name.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the exercise connection configuration.
|
virtual |
Set the federate name In HLA Evolved, this is the same as federateType.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the federate type.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the fed file name.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the FOM mapper initialization data.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the FOM Mapper library name.
Should not be set (or set to "") if no DSO/DLL is used.
Reimplemented from DtExerciseConnInitializer.
|
protectedvirtual |
Initialize Config Variables with names and shortcuts.
|
protectedvirtual |
Start file logging. Done automatically by the reader.
|
protectedvirtual |
Initialize the MTL parameters before loading a configuration file.
Reimplemented in DtF18Initializer, DtLauncherInitializer, and DtF18Initializer.
|
virtual |
Load a .mtl or .xml file.
This method will parse the given file name, and set the initializer parameters to the specified values
|
protectedvirtual |
Used to load configuration when configuration file is MTL.
Reimplemented in DtF18Initializer, and DtF18Initializer.
|
virtual |
Return the NETN FOM revision as an integer.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Returns the NETN FOM Version. See above description.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
|
virtual |
| DtVrlApplicationInitializer& DtVrlApplicationInitializer::operator= | ( | const DtVrlApplicationInitializer & | orig | ) |
Assignment Operator.
|
virtual |
Get print output interval.
|
virtual |
Parse the command line.
This method will parse the command line and set the variables according to what options have been set on the command line
Reimplemented in DtF18Initializer, DtF18Initializer, and DtLauncherInitializer.
|
virtual |
Block the simulation if a save or a restore is in process.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get request class update flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get request object update flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get request when initialized flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Return the RPR FOM revision as an integer.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Returns the RPR FOM Version. See above description.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Save configuration settings to a .xml file.
|
virtual |
Get the send fed time flag. See above description.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the application number.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get request object update flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get default wait list refresh period.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the destroy fed exec flag.
Set the flag that determines whether or not the DtExerciseConn destructor will attempt to destroy the federation execution. Defaults to true.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Block the simulation if a save or a restore is in process.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the federation execution name.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
|
virtual |
Set/Get the federate type.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the fed file name.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the FOM mapper initialization data.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the DSO name.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the Generic attributes flag.
Generic Attributes enables the ability to encode and decode all attributes, even the ones that VR-Link does not understand. Those attributes' bytes are accessible through the state repository.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the NETN FOM Revision to an integer.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the NETN FOM Version.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Sets the notify level for file output, if the filename has been set.
|
virtual |
Setting this will allow notifications to be sent to a file as well as the console.
|
virtual |
Set print output interval.
Set interval between printing output. Defaults to 10 seconds;
|
virtual |
Block the simulation if a save or a restore is in process.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get request class update flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get request object update flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get request when initialized flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the RPR FOM Revision to an integer.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the RPR FOM Version.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the send fed time flag.
Set the flag which determines whether to use Time Stamp Order when sending and receiving interactions. Defaults to false;
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the site number/id.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).
Defaults to DtTimeStampRelative.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the application settings.
|
virtual |
Set/Get the whether to use advisories.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Set/Get the whether to use DIS 5 timestamps.
|
virtual |
Sets the use geographic DDM flag.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get the time stamp type.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
Get use of advisories.
Reimplemented from DtExerciseConnInitializer.
|
virtual |
|
virtual |
Get the use geographic DDM flag.
Reimplemented from DtExerciseConnInitializer.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |