 |
VR-Link API Documentation for HLA 1.3
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Link API Documentation for HLA 1.3
|
Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization data. More...
Inheritance diagram for DtExerciseConnInitializer: Collaboration diagram for DtExerciseConnInitializer:Public Types | |
| enum | DtGetValueMethod { DtForceGetValue, DtForceGetValuePointer, DtGetValuePointerWhereAvailable } |
| Indicate if getValue or getValuePointer should be used to retrieve data from handleValuePairSets. More... | |
Public Member Functions | |
| DtExerciseConnInitializer () | |
| Constructor. More... | |
| virtual | ~DtExerciseConnInitializer () |
| Destructor. More... | |
| DtExerciseConnInitializer (const DtExerciseConnInitializer &orig) | |
| Copy Constructor. More... | |
| DtExerciseConnInitializer & | operator= (const DtExerciseConnInitializer &orig) |
| Assignment Operator. More... | |
| virtual DtString | execName () const |
| Set the federation execution name. More... | |
| virtual void | setExecName (const DtString &name) |
| Get the federation execution name. More... | |
| virtual DtString | federateName () const |
| Set the federate name In HLA Evolved, this is the same as federateType. More... | |
| virtual void | setFederateName (const DtString &name) |
| Set the federate name In HLA Evolved, this is the same as setFederateType. More... | |
| virtual DtString | federateType () const |
| Get the federate type. More... | |
| virtual void | setFederateType (const DtString &type) |
| Set the federate type. More... | |
| virtual DtString | fedFileName () const |
| Set the fed file name. More... | |
| virtual void | setFedFileName (const DtString &name) |
| Get the fed file name. More... | |
| virtual DtFomMapper * | fomMapper () const |
| Set the FOM mapper. More... | |
| virtual void | setFomMapper (DtFomMapper *mapper) |
| Get the FOM mapper. More... | |
| virtual DtString | fomMapperLibName () const |
| Set the FOM Mapper library name. More... | |
| virtual void | setFomMapperLibName (const DtString &name) |
| Get the FOM Mapper library name. More... | |
| virtual void * | fomMapperInitData () const |
| Set the FOM mapper initialization data. More... | |
| virtual void | setFomMapperInitData (void *data) |
| Get the FOM mapper initialization data. More... | |
| virtual void | setRprFomVersion (double version) |
| Set the RPR FOM Version. More... | |
| virtual double | rprFomVersion () const |
| Returns the RPR FOM Version. See above description. More... | |
| virtual void | setNetnFomVersion (double version) |
| Set the NETN FOM Version. More... | |
| virtual double | netnFomVersion () const |
| Returns the NETN FOM Version. See above description. 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 | setUseAdvisories (bool onOff) |
| Set use of advisories. More... | |
| virtual bool | useAdvisories () const |
| Get use of advisories. 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 void | setRequestClassUpdate (bool onOff) |
| Set request class update flag. More... | |
| virtual bool | requestClassUpdate () const |
| Get request class update flag. More... | |
| virtual void | setRequestObjectUpdate (bool onOff) |
| Set request object update flag. More... | |
| virtual bool | requestObjectUpdate () const |
| Get request object update flag. More... | |
| virtual void | setRequestWhenInitialized (bool onOff) |
| Set request when initialized flag. More... | |
| virtual bool | requestWhenInitialized () const |
| Get request when initialized flag. More... | |
| virtual void | setDefaultRefreshWaitList (bool onOff) |
| Set default wait list refresh flag. More... | |
| virtual bool | defaultRefreshWaitList () const |
| Get request object update flag. More... | |
| virtual void | setDefaultWaitListRefreshPeriod (double period) |
| Set 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 bool | dis5Timestamps () const |
| Returns myDis5Timestamps setting. More... | |
| virtual void | setDis5Timestamps (bool onOff) |
| sets the myDis5Timestamps variable 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 | setNotifyLevel (int level) |
| Sets the notify level. 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) |
| Sets the revision of the FOM Mapper currently used. More... | |
| virtual int | rprFomRevision () const |
| Returns the revision of the current FOM being used. More... | |
| virtual void | setNetnFomRevision (int val) |
| Sets the revision of the NETN FOM Mapper currently used. More... | |
| virtual int | netnFomRevision () const |
| Returns the revision of the current NETN FOM being used. More... | |
| virtual void | setExceptionOnRtiCompilerMismatch (bool useException) |
| Set whether DtExerciseConn throws an exception when detecting a mismatched RTI compiler version. More... | |
| virtual bool | exceptionOnRtiCompilerMismatch () const |
| 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... | |
| virtual void | setGenericAttributes (bool yesNo) |
| Set the Generic attributes flag. More... | |
| virtual bool | enabledGenericAttributes () const |
| Set the Generic attributes flag. 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... | |
Static Public Member Functions | |
| static DtString | vrlinkVersion () |
| Returns a string indicating the VR-Link version number. More... | |
Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization data.
| DtExerciseConnInitializer::DtExerciseConnInitializer | ( | ) |
Constructor.
|
virtual |
Destructor.
| DtExerciseConnInitializer::DtExerciseConnInitializer | ( | const DtExerciseConnInitializer & | orig | ) |
Copy Constructor.
|
virtual |
Get auto subscribe flag;.
|
virtual |
Get request object update flag.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get default wait list refresh period.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the destroy fed exec flag. See above description.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Returns myDis5Timestamps setting.
|
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 in DtVrlApplicationInitializer.
|
virtual |
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the federation execution name.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the federate name In HLA Evolved, this is the same as federateType.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the federate type.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the fed file name.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the FOM mapper.
|
virtual |
Set the FOM mapper initialization data.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the FOM Mapper library name.
Should not be set (or set to "") if no DSO/DLL is used.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Configure how VR-Link retrieves data from RTI attribute/parameter handle value pair sets.
When retrieving data from RTI attribute/parameter handle value pair sets, getValuePointer is more efficient but it may not guarantee 64-bit alignment. The alternative is the getValue method which copies the data from the set into safe VR-Link buffers. Versions of the MAK RTI 4.3 and beyond guarantee that getValuePointer returns a pointer that is 64-bit aligned. By default (DtGetValuePointerWhereAvailable), VR-Link will inspect the RTI version and use getValuePointer when it can determine that the RTI supports it; otherwise, VR-Link will use getValue. The alternatives DtForceGetValue and DtForceGetValuePointer force VR-Link to use getValue and getValuePointer respectively, regardless of the RTI version.
|
virtual |
Returns the revision of the current NETN FOM being used.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Returns the NETN FOM Version. See above description.
Reimplemented in DtVrlApplicationInitializer.
| DtExerciseConnInitializer& DtExerciseConnInitializer::operator= | ( | const DtExerciseConnInitializer & | orig | ) |
Assignment Operator.
|
virtual |
Get passive mode. See above description.
|
virtual |
Block the simulation if a save or a restore is in process.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get reflecting. See above description.
|
virtual |
Get reflect remove updates into publisher flag.
|
virtual |
Get the reflecting through RTI flag.
|
virtual |
Get reply to sync points. See above description.
|
virtual |
Get request class update flag.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get request object update flag.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get request when initialized flag.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Returns the revision of the current FOM being used.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Returns the RPR FOM Version. See above description.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the send fed time flag. See above description.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set auto subscribe flag.
Set flag which determines whether to automatically subscribe to interaction classes for which callbacks are being registered. Defaults to true;
|
virtual |
Set default wait list refresh flag.
Set the default flag for resending object request updates. When any of the automatic request flags are enabled, discovered objects that do not meet their reflected list discovery criteria are placed on a refresh list. The automatic requests should elicit an update from the owning federate that will satisfy the discovery criteria and remove the object from the wait list. If an update is not received within the wait list refresh period, a request will be resent. This value is the default used to initialize reflected lists, but each individual list can change the refresh period independently once created. Defaults to true;
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set default wait list refresh period.
Set the default period for resending object request updates. Defaults to 10 seconds;
Reimplemented in DtVrlApplicationInitializer.
|
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 in DtVrlApplicationInitializer.
|
virtual |
sets the myDis5Timestamps variable
|
virtual |
Set whether DtExerciseConn throws an exception when detecting a mismatched RTI compiler version.
Set the flag which determines whether to throw an exception or print a warning when a compiler version mismatch is detected. Default is set to True. Disable if the compiler version mismatch is intentional or wrongfully detected.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the federation execution name.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the federate name In HLA Evolved, this is the same as setFederateType.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
|
virtual |
Get the fed file name.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the FOM mapper.
|
virtual |
Get the FOM mapper initialization data.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the FOM Mapper library name.
Reimplemented in DtVrlApplicationInitializer.
|
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 in DtVrlApplicationInitializer.
|
virtual |
Configure how VR-Link retrieves data from RTI attribute/parameter handle value pair sets.
When retrieving data from RTI attribute/parameter handle value pair sets, getValuePointer is more efficient but it may not guarantee 64-bit alignment. The alternative is the getValue method which copies the data from the set into safe VR-Link buffers. Versions of the MAK RTI 4.3 and beyond guarantee that getValuePointer returns a pointer that is 64-bit aligned. By default (DtGetValuePointerWhereAvailable), VR-Link will inspect the RTI version and use getValuePointer when it can determine that the RTI supports it; otherwise, VR-Link will use getValue. The alternatives DtForceGetValue and DtForceGetValuePointer force VR-Link to use getValue and getValuePointer respectively, regardless of the RTI version.
|
virtual |
Sets the revision of the NETN FOM Mapper currently used.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the NETN FOM Version.
If no FOM Mapper library is specified, the NETN FOM Version will be used to create a NETN FOM Mapper of the version specified Defaulted to 3.0
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Sets the notify level.
|
virtual |
Set passive mode.
If this is true, This will listen to HLA data but request nothing. Defaults to false.
|
virtual |
Block the simulation if a save or a restore is in process.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set reflecting.
If this is true, local objects/interactions will be reflected back to us. Defaults to false.
|
virtual |
Set the reflectRemoteUpdatesIntoPub flag.
If the reflecting flag is on (see above), then we may publishers and reflected objects with different state repositories for the same HLA object. Updates that we send locally get reflected into our "reflected" view of the object. If the reflectRemoteUpdatesIntoPub flag is set, we will additionally reflect any remote updates into our publisher's state repository. This will mean that the publisher's state repository represents the best truth we know: values we've set for attributes we own, plus values we've received for attributes we don't. If this flag is off, then the publisher's state repository will contain only values that have been set locally. Defaults to true.
|
virtual |
Set the reflecting through RTI flag to true.
Use only in rare cases when you want setReflecting() to be implemented by spoofing federate ambassador calls rather than by reflecting directly into VR-Link classes. Defaults to false.
|
virtual |
Set reply to sync points.
If true, DtExerciseConn will automatically send sync point achieved to the RTI on receipt of announce sync point. Defaults to true;
|
virtual |
Set request class update flag.
Set flag which determines whether to automatically request class updates for object classes associated with reflected lists. Defaults to true;
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set request object update flag.
Set flag which determines whether to automatically request updates from discovered objects. Defaults to true
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set request when initialized flag.
Set flag which determines whether to manage object requests for discovered objects using a vr-link status object to determine when federates are initialized (subscribed and registered and updated initial objects). Requests are only managed when federates make calls on the exercise connection to update their execution status. This flag should be set when there is a high entity count in the federation execution scenario. Setting this flag overrides both the request class and request object update flags (to false) and automatically enables the wait list refresh on all reflected lists. Defaults to false
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Sets the revision of the FOM Mapper currently used.
Revisions are used to indicate a slight change for a given version of a FOM. For example, RPR FOM 2 D17 is a released version of the RPR FOM. However, some encoding errors were made in VR-Link. Rather than break backwards compatibility, VR-Link now allows the user to choose a specific revision of RPR FOM V 2D17 to be used.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set the RPR FOM Version.
If a shared FOM Mapper library name is not specified, and no FOM Mapper library is specified, the RPR FOM Version will be used to create a RPR FOM Mapper of the version specified Defaulted to 1.0.
Reimplemented in DtVrlApplicationInitializer.
|
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 in DtVrlApplicationInitializer.
|
virtual |
Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).
Defaults to DtTimeStampRelative.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Set use of advisories.
If set to true, VR-Link should send updates for classes, attributes, and interactions based on advisories describing the existence of remote subscribing federates. See advisories description in DtExerciseConn class docs. Defaults to true;
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Sets the use geographic DDM flag.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the time stamp type.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get use of advisories.
Reimplemented in DtVrlApplicationInitializer.
|
virtual |
Get the use geographic DDM flag.
Reimplemented in DtVrlApplicationInitializer.
|
static |
Returns a string indicating the VR-Link version number.
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
These values are private, because derived classes will be providing types of the same functionality...
just with a different type
|
private |
|
private |
|
private |
The following two variables are different representations of the same concept.
myFedFileName represents the fed file name to be used in the Federation Execution.
|
private |
|
private |
|
private |
|
private |
myFomModules represents the set of FOM Modules to be used to establish the Object Model of the Federation Execution.
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
