DtExerciseConnInitializer Class Reference

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.
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	federateName () const
	Set the federate name In HLA Evolved, this is the same as federateType.
virtual void	setFederateName (const DtString &name)
	Set the federate name In HLA Evolved, this is the same as setFederateType.
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	setPassiveMode (bool onOff)
	Set passive mode.
virtual bool	passiveMode () const
	Get passive mode. 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	setExceptionOnRtiCompilerMismatch (bool useException)
	Set whether DtExerciseConn throws an exception when detecting a mismatched RTI compiler version.
virtual bool	exceptionOnRtiCompilerMismatch () const
virtual void	setMimModule (const DtString &mimFomModule)
	Specify the MOM and Initialization Module (MIM)
virtual DtString	mimModule () const
	Return the name of the MOM and Initialization Module (MIM)
virtual void	addFomModule (const DtString &module)
	Add a single FOM Module.
virtual void	setFomModules (const std::vector< DtString > &fomModules)
	Add a set of FOM Modules.
virtual void	fomModules (std::vector< DtString > &fomModules) const
	Get a list of FOM Modules as DtStrings passed to the RTI.
virtual void	fomModules (std::vector< std::wstring > &fomModules) const
	Get a list of FOM Modules as std::wstring passed to the RTI.
virtual void	setLocalSettingsDesignator (const std::wstring &localSettingsDesignator)
	local settings designator ( wstring )
virtual void	setLocalSettingsDesignator (const DtString &localSettingsDesignator)
	local settings designator ( DtString )
virtual std::wstring	localSettingsDesignator () const
	Get the local settings designator.
virtual void	setGetValueMethod (DtGetValueMethod getValueMethodChoice)
	Configure how VR-Link retrieves data from RTI attribute/parameter handle value pair sets.
virtual DtGetValueMethod	getValueMethod () const
	Configure how VR-Link retrieves data from RTI attribute/parameter handle value pair sets.
virtual void	setGenericAttributes (bool yesNo)
	Set the Generic attributes flag.
virtual bool	enabledGenericAttributes () const
	Set the Generic attributes flag.
virtual bool	pauseOnSaveRestore () const
	Block the simulation if a save or a restore is in process.
virtual void	setPauseOnSaveRestore (bool yesNo)
	Block the simulation if a save or a restore is in process.

Static Public Member Functions
static DtString	vrlinkVersion ()
	Returns a string indicating the VR-Link version number.

Private Attributes
DtString	myExecName
	These values are private, because derived classes will be providing types of the same functionality...
DtString	myFederateType
DtString	myFederateName
DtFomMapper *	myFomMapper
DtString	myFomMapperLibName
void *	myFomMapperInitData
double	myRprFomVersion
bool	myReflecting
bool	myPassiveMode
bool	myUseAdvisories
bool	myReplyToSynchPoints
bool	myAutoSubscribe
bool	myReflectRemoteUpdatesIntoPub
bool	myReflectThroughRti
DtTimeStampType	myTimeStampType
bool	myDestroyFedExec
bool	mySendFedTime
bool	myPauseOnSaveRestore
bool	myGenericAttributes
bool	myUseGeographicDdm
int	myRprFomRevision
bool	myExceptionOnRtiCompilerMismatch
DtGetValueMethod	myGetValueMethod
std::wstring	myLocalSettingsDesignator
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

Detailed Description

Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization data.

Member Enumeration Documentation

enum DtExerciseConnInitializer::DtGetValueMethod

Indicate if getValue or getValuePointer should be used to retrieve data from handleValuePairSets.

Enumerator:

DtForceGetValue
DtForceGetValuePointer
DtGetValuePointerWhereAvailable

Constructor & Destructor Documentation

DtExerciseConnInitializer::DtExerciseConnInitializer

(

)

Constructor.

virtual DtExerciseConnInitializer::~DtExerciseConnInitializer ( )

virtual

Destructor.

DtExerciseConnInitializer::DtExerciseConnInitializer

(

const DtExerciseConnInitializer &

orig

)

Copy Constructor.

Member Function Documentation

virtual void DtExerciseConnInitializer::addFomModule ( const DtString &  module )

virtual

Add a single FOM Module.

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 bool DtExerciseConnInitializer::enabledGenericAttributes ( ) const

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 bool DtExerciseConnInitializer::exceptionOnRtiCompilerMismatch ( ) const

virtual

Reimplemented in DtVrlApplicationInitializer.

virtual DtString DtExerciseConnInitializer::execName ( ) const

virtual

Set the execution name.

Reimplemented in DtVrlApplicationInitializer.

virtual DtString DtExerciseConnInitializer::federateName ( ) const

virtual

Set the federate name In HLA Evolved, this is the same as federateType.

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.

virtual void DtExerciseConnInitializer::fomModules ( std::vector< DtString > &  fomModules ) const

virtual

Get a list of FOM Modules as DtStrings passed to the RTI.

virtual void DtExerciseConnInitializer::fomModules ( std::vector< std::wstring > &  fomModules ) const

virtual

Get a list of FOM Modules as std::wstring passed to the RTI.

virtual DtGetValueMethod DtExerciseConnInitializer::getValueMethod ( ) const

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 std::wstring DtExerciseConnInitializer::localSettingsDesignator ( ) const

virtual

Get the local settings designator.

Reimplemented in DtVrlApplicationInitializer.

virtual DtString DtExerciseConnInitializer::mimModule ( ) const

virtual

Return the name of the MOM and Initialization Module (MIM)

Reimplemented in DtVrlApplicationInitializer.

DtExerciseConnInitializer& DtExerciseConnInitializer::operator=

(

const DtExerciseConnInitializer &

orig

)

Assignment Operator.

virtual bool DtExerciseConnInitializer::passiveMode ( ) const

virtual

Get passive mode. See above description.

virtual bool DtExerciseConnInitializer::pauseOnSaveRestore ( ) const

virtual

Block the simulation if a save or a restore is in process.

Reimplemented in DtVrlApplicationInitializer.

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.

See Also

setRprFomRevision

Reimplemented in DtVrlApplicationInitializer.

virtual double DtExerciseConnInitializer::rprFomVersion ( ) const

virtual

Returns the RPR FOM Version. See above description.

Reimplemented in DtVrlApplicationInitializer.

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::setExceptionOnRtiCompilerMismatch ( bool  useException )

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 void DtExerciseConnInitializer::setExecName ( const DtString &  name )

virtual

Get the execution name.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setFederateName ( const DtString &  name )

virtual

Set the federate name In HLA Evolved, this is the same as setFederateType.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setFederateType ( const DtString &  type )

virtual

Set the federate type.

Evolved only.

Reimplemented in DtVrlApplicationInitializer.

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::setFomModules ( const std::vector< DtString > &  fomModules )

virtual

Add a set of FOM Modules.

virtual void DtExerciseConnInitializer::setGenericAttributes ( bool  yesNo )

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 void DtExerciseConnInitializer::setGetValueMethod ( DtGetValueMethod  getValueMethodChoice )

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 void DtExerciseConnInitializer::setLocalSettingsDesignator ( const std::wstring &  localSettingsDesignator )

virtual

local settings designator ( wstring )

virtual void DtExerciseConnInitializer::setLocalSettingsDesignator ( const DtString &  localSettingsDesignator )

virtual

local settings designator ( DtString )

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setMimModule ( const DtString &  mimFomModule )

virtual

Specify the MOM and Initialization Module (MIM)

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setNotifyLevel ( int  level )

virtual

Sets the notify level.

virtual void DtExerciseConnInitializer::setPassiveMode ( bool  onOff )

virtual

Set passive mode.

If this is true, This will listen to HLA data but request nothing. Defaults to false.

virtual void DtExerciseConnInitializer::setPauseOnSaveRestore ( bool  yesNo )

virtual

Block the simulation if a save or a restore is in process.

Reimplemented in DtVrlApplicationInitializer.

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::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.

static DtString DtExerciseConnInitializer::vrlinkVersion ( )

static

Returns a string indicating the VR-Link version number.

Member Data Documentation

bool DtExerciseConnInitializer::myAutoSubscribe

private

bool DtExerciseConnInitializer::myDestroyFedExec

private

bool DtExerciseConnInitializer::myExceptionOnRtiCompilerMismatch

private

DtString DtExerciseConnInitializer::myExecName

private

These values are private, because derived classes will be providing types of the same functionality...

just with a different type

DtString DtExerciseConnInitializer::myFederateName

private

DtString DtExerciseConnInitializer::myFederateType

private

DtString DtExerciseConnInitializer::myFedFileName

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.

DtFomMapper* DtExerciseConnInitializer::myFomMapper

private

void* DtExerciseConnInitializer::myFomMapperInitData

private

DtString DtExerciseConnInitializer::myFomMapperLibName

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::myGenericAttributes

private

DtGetValueMethod DtExerciseConnInitializer::myGetValueMethod

private

std::wstring DtExerciseConnInitializer::myLocalSettingsDesignator

private

DtString DtExerciseConnInitializer::myMimModule

private

bool DtExerciseConnInitializer::myPassiveMode

private

bool DtExerciseConnInitializer::myPauseOnSaveRestore

private

bool DtExerciseConnInitializer::myReflecting

private

bool DtExerciseConnInitializer::myReflectRemoteUpdatesIntoPub

private

bool DtExerciseConnInitializer::myReflectThroughRti

private

bool DtExerciseConnInitializer::myReplyToSynchPoints

private

int DtExerciseConnInitializer::myRprFomRevision

private

double DtExerciseConnInitializer::myRprFomVersion

private

bool DtExerciseConnInitializer::mySendFedTime

private

DtTimeStampType DtExerciseConnInitializer::myTimeStampType

private

bool DtExerciseConnInitializer::myUseAdvisories

private

bool DtExerciseConnInitializer::myUseGeographicDdm

private

---

The documentation for this class was generated from the following file:

• exerciseConnInitializerHLA.h