 |
VR-Link API Documentation for HLA 1516
|
|
VR-Link API Documentation for HLA 1516
|
Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization data. More...
Inheritance diagram for DtExerciseConnInitializer: Collaboration diagram for DtExerciseConnInitializer:Public Member Functions | |
| DtExerciseConnInitializer () | |
| Constructor. | |
| virtual | ~DtExerciseConnInitializer () |
| Destructor. | |
| DtExerciseConnInitializer (const DtExerciseConnInitializer &orig) | |
| Copy Constructor. | |
| DtExerciseConnInitializer & | operator= (const DtExerciseConnInitializer &orig) |
| Assignment Operator. | |
| virtual DtString | execName () const |
| Set the execution name. | |
| virtual void | setExecName (const DtString &name) |
| Get the execution name. | |
| virtual DtString | federateType () const |
| Get the federate type. | |
| virtual void | setFederateType (const DtString &type) |
| Set the federate type. | |
| virtual DtString | fedFileName () const |
| Set the fed file name. | |
| virtual void | setFedFileName (const DtString &name) |
| Get the fed file name. | |
| virtual DtFomMapper * | fomMapper () const |
| Set the FOM mapper. | |
| virtual void | setFomMapper (DtFomMapper *mapper) |
| Get the FOM mapper. | |
| virtual DtString | fomMapperLibName () const |
| Set the FOM Mapper library name. | |
| virtual void | setFomMapperLibName (const DtString &name) |
| Get the FOM Mapper library name. | |
| virtual void * | fomMapperInitData () const |
| Set the FOM mapper initialization data. | |
| virtual void | setFomMapperInitData (void *data) |
| Get the FOM mapper initialization data. | |
| virtual void | setRprFomVersion (double version) |
| Set the RPR FOM Version. | |
| virtual double | rprFomVersion () const |
| Returns the RPR FOM Version. See above description. | |
| virtual void | setReflecting (bool onOff) |
| Set reflecting. | |
| virtual bool | reflecting () const |
| Get reflecting. See above description. | |
| virtual void | setReflectRemoteUpdatesIntoPub (bool onOff) |
| Set the reflectRemoteUpdatesIntoPub flag. | |
| virtual bool | reflectRemoteUpdatesIntoPub () const |
| Get reflect remove updates into publisher flag. | |
| virtual void | setReflectThroughRti (bool onOff) |
| Set the reflecting through RTI flag to true. | |
| virtual bool | reflectThroughRti () const |
| Get the reflecting through RTI flag. | |
| virtual void | setUseAdvisories (bool onOff) |
| Set use of advisories. | |
| virtual bool | useAdvisories () const |
| Get use of advisories. | |
| virtual void | setReplyToSynchPoints (bool onOff) |
| Set reply to sync points. | |
| virtual bool | replyToSynchPoints () const |
| Get reply to sync points. See above description. | |
| virtual void | setAutoSubscribe (bool onOff) |
| Set auto subscribe flag. | |
| virtual bool | autoSubscribe () const |
| Get auto subscribe flag;. | |
| virtual void | setTimeStampType (DtTimeStampType relOrAbs) |
| Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative). | |
| virtual DtTimeStampType | timeStampType () const |
| Get the time stamp type. | |
| virtual void | setDestroyFedExec (bool onOff) |
| Set the destroy fed exec flag. | |
| virtual bool | destroyFedExec () const |
| Get the destroy fed exec flag. See above description. | |
| virtual void | setSendFedTime (bool onOff) |
| Set the send fed time flag. | |
| virtual bool | sendFedTime () const |
| Get the send fed time flag. See above description. | |
| virtual void | setNotifyLevel (int level) |
| Sets the notify level. | |
| virtual void | setUseGeographicDdm (bool yesNo) |
| Sets the use geographic DDM flag. | |
| virtual bool | useGeographicDdm () const |
| Get the use geographic DDM flag. | |
| virtual void | setRprFomRevision (int val) |
| Sets the revision of the FOM Mapper currently used. | |
| virtual int | rprFomRevision () const |
| returns the revision of the current FOM being used. | |
| virtual void | setRtiArguments (const std::vector< std::wstring > &args) |
| Specify the vector of wstring args to pass to HLA 1516's RTIambassador constructor. | |
| virtual void | setRtiArguments (const std::vector< DtString > &args) |
| Specify the vector of wstring args to pass to HLA 1516's RTIambassador constructor. | |
| virtual void | rtiArguments (std::vector< std::wstring > &args) const |
| Returns the rtiArguments which will be passed to HLA 1516's RTI ambassador constructor. | |
Private Attributes | |
| DtString | myExecName |
| These values are private, because derived classes will be providing types of the same functionality... | |
| DtString | myFederateType |
| DtFomMapper * | myFomMapper |
| DtString | myFomMapperLibName |
| void * | myFomMapperInitData |
| double | myRprFomVersion |
| bool | myReflecting |
| bool | myUseAdvisories |
| bool | myReplyToSynchPoints |
| bool | myAutoSubscribe |
| bool | myReflectRemoteUpdatesIntoPub |
| bool | myReflectThroughRti |
| DtTimeStampType | myTimeStampType |
| bool | myDestroyFedExec |
| bool | mySendFedTime |
| bool | myUseGeographicDdm |
| int | myRprFomRevision |
| std::vector< std::wstring > | myRtiArguments |
| DtString | myFedFileName |
| The following two variables are different representations of the same concept. | |
| std::vector< DtString > | myFomModules |
| myFomModules represents the set of FOM Modules to be used to establish the Object Model of the Federation Execution. | |
| DtString | myMimModule |
Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization data.
Constructor.
| virtual DtExerciseConnInitializer::~DtExerciseConnInitializer | ( | ) | [virtual] |
Destructor.
Copy Constructor.
| virtual bool DtExerciseConnInitializer::autoSubscribe | ( | ) | const [virtual] |
Get auto subscribe flag;.
| virtual bool DtExerciseConnInitializer::destroyFedExec | ( | ) | const [virtual] |
Get the destroy fed exec flag. See above description.
Reimplemented in DtVrlApplicationInitializer.
| virtual DtString DtExerciseConnInitializer::execName | ( | ) | const [virtual] |
Set the execution name.
Reimplemented in DtVrlApplicationInitializer.
| virtual DtString DtExerciseConnInitializer::federateType | ( | ) | const [virtual] |
Get the federate type.
Reimplemented in DtVrlApplicationInitializer.
| virtual DtString DtExerciseConnInitializer::fedFileName | ( | ) | const [virtual] |
Set the fed file name.
Reimplemented in DtVrlApplicationInitializer.
| virtual DtFomMapper* DtExerciseConnInitializer::fomMapper | ( | ) | const [virtual] |
Set the FOM mapper.
| virtual void* DtExerciseConnInitializer::fomMapperInitData | ( | ) | const [virtual] |
Set the FOM mapper initialization data.
Reimplemented in DtVrlApplicationInitializer.
| virtual DtString DtExerciseConnInitializer::fomMapperLibName | ( | ) | const [virtual] |
Set the FOM Mapper library name.
Should not be set (or set to "") if no DSO/DLL is used.
Reimplemented in DtVrlApplicationInitializer.
| DtExerciseConnInitializer& DtExerciseConnInitializer::operator= | ( | const DtExerciseConnInitializer & | orig | ) |
Assignment Operator.
| virtual bool DtExerciseConnInitializer::reflecting | ( | ) | const [virtual] |
Get reflecting. See above description.
| virtual bool DtExerciseConnInitializer::reflectRemoteUpdatesIntoPub | ( | ) | const [virtual] |
Get reflect remove updates into publisher flag.
| virtual bool DtExerciseConnInitializer::reflectThroughRti | ( | ) | const [virtual] |
Get the reflecting through RTI flag.
| virtual bool DtExerciseConnInitializer::replyToSynchPoints | ( | ) | const [virtual] |
Get reply to sync points. See above description.
| virtual int DtExerciseConnInitializer::rprFomRevision | ( | ) | const [virtual] |
returns the revision of the current FOM being used.
Reimplemented in DtVrlApplicationInitializer.
| virtual double DtExerciseConnInitializer::rprFomVersion | ( | ) | const [virtual] |
Returns the RPR FOM Version. See above description.
Reimplemented in DtVrlApplicationInitializer.
| virtual void DtExerciseConnInitializer::rtiArguments | ( | std::vector< std::wstring > & | args | ) | const [virtual] |
Returns the rtiArguments which will be passed to HLA 1516's RTI ambassador constructor.
| virtual bool DtExerciseConnInitializer::sendFedTime | ( | ) | const [virtual] |
Get the send fed time flag. See above description.
Reimplemented in DtVrlApplicationInitializer.
| virtual void DtExerciseConnInitializer::setAutoSubscribe | ( | bool | onOff | ) | [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 void DtExerciseConnInitializer::setDestroyFedExec | ( | bool | onOff | ) | [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 void DtExerciseConnInitializer::setExecName | ( | const DtString & | name | ) | [virtual] |
Get the execution name.
Reimplemented in DtVrlApplicationInitializer.
| virtual void DtExerciseConnInitializer::setFederateType | ( | const DtString & | type | ) | [virtual] |
| virtual void DtExerciseConnInitializer::setFedFileName | ( | const DtString & | name | ) | [virtual] |
Get the fed file name.
Reimplemented in DtVrlApplicationInitializer.
| virtual void DtExerciseConnInitializer::setFomMapper | ( | DtFomMapper * | mapper | ) | [virtual] |
Get the FOM mapper.
| virtual void DtExerciseConnInitializer::setFomMapperInitData | ( | void * | data | ) | [virtual] |
Get the FOM mapper initialization data.
Reimplemented in DtVrlApplicationInitializer.
| virtual void DtExerciseConnInitializer::setFomMapperLibName | ( | const DtString & | name | ) | [virtual] |
Get the FOM Mapper library name.
Reimplemented in DtVrlApplicationInitializer.
| virtual void DtExerciseConnInitializer::setNotifyLevel | ( | int | level | ) | [virtual] |
Sets the notify level.
| virtual void DtExerciseConnInitializer::setReflecting | ( | bool | onOff | ) | [virtual] |
Set reflecting.
If this is true, local objects/interactions will be reflected back to us. Defaults to false.
| virtual void DtExerciseConnInitializer::setReflectRemoteUpdatesIntoPub | ( | bool | onOff | ) | [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 void DtExerciseConnInitializer::setReflectThroughRti | ( | bool | onOff | ) | [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 void DtExerciseConnInitializer::setReplyToSynchPoints | ( | bool | onOff | ) | [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 void DtExerciseConnInitializer::setRprFomRevision | ( | int | val | ) | [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 void DtExerciseConnInitializer::setRprFomVersion | ( | double | version | ) | [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 void DtExerciseConnInitializer::setRtiArguments | ( | const std::vector< std::wstring > & | args | ) | [virtual] |
Specify the vector of wstring args to pass to HLA 1516's RTIambassador constructor.
| virtual void DtExerciseConnInitializer::setRtiArguments | ( | const std::vector< DtString > & | args | ) | [virtual] |
Specify the vector of wstring args to pass to HLA 1516's RTIambassador constructor.
| virtual void DtExerciseConnInitializer::setSendFedTime | ( | bool | onOff | ) | [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 void DtExerciseConnInitializer::setTimeStampType | ( | DtTimeStampType | relOrAbs | ) | [virtual] |
Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).
Defaults to DtTimeStampRelative.
Reimplemented in DtVrlApplicationInitializer.
| virtual void DtExerciseConnInitializer::setUseAdvisories | ( | bool | onOff | ) | [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 void DtExerciseConnInitializer::setUseGeographicDdm | ( | bool | yesNo | ) | [virtual] |
Sets the use geographic DDM flag.
Reimplemented in DtVrlApplicationInitializer.
| virtual DtTimeStampType DtExerciseConnInitializer::timeStampType | ( | ) | const [virtual] |
Get the time stamp type.
Reimplemented in DtVrlApplicationInitializer.
| virtual bool DtExerciseConnInitializer::useAdvisories | ( | ) | const [virtual] |
Get use of advisories.
Reimplemented in DtVrlApplicationInitializer.
| virtual bool DtExerciseConnInitializer::useGeographicDdm | ( | ) | const [virtual] |
Get the use geographic DDM flag.
Reimplemented in DtVrlApplicationInitializer.
bool DtExerciseConnInitializer::myAutoSubscribe [private] |
bool DtExerciseConnInitializer::myDestroyFedExec [private] |
These values are private, because derived classes will be providing types of the same functionality...
just with a different type
The following two variables are different representations of the same concept.
myFedFileName represents the fed file name to be used in the Federation Execution.
void* DtExerciseConnInitializer::myFomMapperInitData [private] |
std::vector<DtString> DtExerciseConnInitializer::myFomModules [private] |
myFomModules represents the set of FOM Modules to be used to establish the Object Model of the Federation Execution.
bool DtExerciseConnInitializer::myReflecting [private] |
bool DtExerciseConnInitializer::myReflectRemoteUpdatesIntoPub [private] |
bool DtExerciseConnInitializer::myReflectThroughRti [private] |
bool DtExerciseConnInitializer::myReplyToSynchPoints [private] |
int DtExerciseConnInitializer::myRprFomRevision [private] |
double DtExerciseConnInitializer::myRprFomVersion [private] |
std::vector<std::wstring> DtExerciseConnInitializer::myRtiArguments [private] |
bool DtExerciseConnInitializer::mySendFedTime [private] |
bool DtExerciseConnInitializer::myUseAdvisories [private] |
bool DtExerciseConnInitializer::myUseGeographicDdm [private] |
