DtVrlApplicationInitializer Class Reference

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 &version=DtExerciseConnInitializer::vrlinkVersion(), bool pressAnyKey=false)
	Constructor.
virtual	~DtVrlApplicationInitializer ()
	Destructor.
virtual int	argc () const
	Get the argc passed into the constructor.
virtual char **	argv () const
	Get the argv passed into the constructor.
virtual void	parseCmdLine ()
	Parse the command line.
virtual void	loadFile (const DtString &fileName)
	Load a .mtl or .xml file.
virtual void	loadMtlFile (const DtString &fileName)
virtual void	saveFile (const DtString &filename)
	Save configuration settings to a .xml file.
virtual void	setExecName (const DtString &name)
	Set/Get the execution name.
virtual DtString	execName () const
	Set the execution name.
virtual void	setFederateName (const DtString &name)
	HLA Evolved only.
virtual DtString	federateName () const
	Set the federate name In HLA Evolved, this is the same as federateType.
virtual void	setLocalSettingsDesignator (const DtString &name)
	HLA Evolved only.
virtual std::wstring	localSettingsDesignator () const
	Get the local settings designator.
virtual void	setMimModule (const DtString &mimFomModule)
	Set/Get the MOM and Initialization Module (MIM) HLA Evolved only.
virtual DtString	mimModule () const
	Return the name of the MOM and Initialization Module (MIM)
virtual void	setFederateType (const DtString &type)
	Set/Get the federate type.
virtual DtString	federateType () const
	Get the federate type.
void	setFedFileName (const DtString &name)
	Set/Get the fed file name.
virtual DtString	fedFileName () const
	Set the fed file name.
virtual void	setFomMapperLibName (const DtString &name)
	Set/Get the DSO name.
virtual DtString	fomMapperLibName () const
	Set the FOM Mapper library name.
virtual void	setRprFomVersion (double version)
	Set/Get the RPR FOM Version.
virtual double	rprFomVersion () const
	Returns the RPR FOM Version. See above description.
virtual void *	fomMapperInitData () const
	Set/Get the FOM mapper initialization data.
virtual void	setFomMapperInitData (void *data)
	Get the FOM mapper initialization data.
virtual void	setUseAdvisories (bool onOff)
	Set use of advisories.
virtual bool	useAdvisories () const
	Get use of advisories.
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	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	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.
virtual void	setExceptionOnRtiCompilerMismatch (bool yesNo)
	Block the simulation if a save or a restore is in process.
virtual bool	exceptionOnRtiCompilerMismatch () const
	Block the simulation if a save or a restore is in process.
Public Member Functions inherited from DtExerciseConnInitializer
	DtExerciseConnInitializer ()
	Constructor.
virtual	~DtExerciseConnInitializer ()
	Destructor.
	DtExerciseConnInitializer (const DtExerciseConnInitializer &orig)
	Copy Constructor.
DtExerciseConnInitializer &	operator= (const DtExerciseConnInitializer &orig)
	Assignment Operator.
virtual DtFomMapper *	fomMapper () const
	Set the FOM mapper.
virtual void	setFomMapper (DtFomMapper *mapper)
	Get the FOM mapper.
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	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	setNotifyLevel (int level)
	Sets the notify level.
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	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.

Protected Member Functions
virtual void	initializeMtlParams ()

Protected Attributes
int	myArgc
char **	myArgv
DtMtlEnvironment *	myMtlEnv
DtApplicationSettings	mySettings
DtConfigVariable< int >	myConfigVarNotifyLevel
DtVariableGroup	myHlaConnection
DtConfigVariable< DtString >	myConfigVarFederateType
DtConfigVariable< DtString >	myConfigVarExecName
DtConfigVariable< DtString >	myConfigVarFedFileName
DtConfigVariable< DtString >	myConfigVarFederateName
DtMultiConfigVariable< DtString >	myConfigVarFomModules
DtConfigVariable< DtString >	myConfigVarMimModule
DtConfigVariable< DtString >	myConfigVarLocalSettingsDesignator
DtConfigVariable< DtString >	myConfigVarFomMapperLibName
DtConfigVariable< DtString >	myConfigVarFomMapperInitData
DtConfigVariable< double >	myConfigVarRprFomVersion
DtConfigVariable< int >	myConfigVarRprFomRevision
DtConfigVariable< bool >	myConfigVarUseAdvisories
DtConfigVariable< bool >	myConfigVarIgnoreAdvisories
DtConfigVariable< bool >	myConfigVarUseGeographicDdm
DtConfigVariable< bool >	myConfigVarUseAbsoluteTimestamps
DtConfigVariable< bool >	myConfigVarDestroyFedExec
DtConfigVariable< bool >	myConfigVarSendFedTime
DtConfigVariable< bool >	myConfigVarGenericAttributes
DtConfigVariable< bool >	myConfigVarPauseOnSaveRestore
DtConfigVariable< bool >	myConfigVarRtiCompilerCheck
int	myMtlUseAdvisories
int	myMtlUseGeographicDdm
int	myMtlUseAbsoluteTimeStamps
int	myMtlDestroyFedExec
int	myMtlSendFedTime
int	myMtlPauseOnSaveRestore

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.

Detailed Description

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

Examples

• Talk
• Listen

Constructor & Destructor Documentation

DtVrlApplicationInitializer::DtVrlApplicationInitializer	(	int	argc,
		char *	argv[],
		const DtString &	appName,
		const DtString &	version = DtExerciseConnInitializer::vrlinkVersion(),
		bool	pressAnyKey = false
	)

Constructor.

virtual DtVrlApplicationInitializer::~DtVrlApplicationInitializer ( )

virtual

Destructor.

Member Function Documentation

virtual int DtVrlApplicationInitializer::argc ( ) const

virtual

Get the argc passed into the constructor.

virtual char** DtVrlApplicationInitializer::argv ( ) const

virtual

Get the argv passed into the constructor.

virtual bool DtVrlApplicationInitializer::destroyFedExec ( ) const

virtual

Get the destroy fed exec flag. See above description.

Reimplemented from DtExerciseConnInitializer.

virtual bool DtVrlApplicationInitializer::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 from DtExerciseConnInitializer.

virtual bool DtVrlApplicationInitializer::exceptionOnRtiCompilerMismatch ( ) const

virtual

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

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::execName ( ) const

virtual

Set the execution name.

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::federateName ( ) const

virtual

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

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::federateType ( ) const

virtual

Get the federate type.

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::fedFileName ( ) const

virtual

Set the fed file name.

Reimplemented from DtExerciseConnInitializer.

virtual void* DtVrlApplicationInitializer::fomMapperInitData ( ) const

virtual

Set/Get the FOM mapper initialization data.

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::fomMapperLibName ( ) const

virtual

Set the FOM Mapper library name.

Should not be set (or set to "") if no DSO/DLL is used.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::initializeMtlParams ( )

protectedvirtual

Reimplemented in DtLauncherInitializer, DtF18Initializer, and DtF18Initializer.

virtual void DtVrlApplicationInitializer::loadFile ( const DtString &  fileName )

virtual

Load a .mtl or .xml file.

This method will parse the given file name, and set the initializer parameters to the specified values

virtual void DtVrlApplicationInitializer::loadMtlFile ( const DtString &  fileName )

virtual

Reimplemented in DtF18Initializer, and DtF18Initializer.

virtual std::wstring DtVrlApplicationInitializer::localSettingsDesignator ( ) const

virtual

Get the local settings designator.

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::mimModule ( ) const

virtual

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

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::parseCmdLine ( )

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 bool DtVrlApplicationInitializer::pauseOnSaveRestore ( ) const

virtual

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

Reimplemented from DtExerciseConnInitializer.

virtual int DtVrlApplicationInitializer::rprFomRevision ( ) const

virtual

returns the revision of the current FOM being used.

See Also

setRprFomRevision

Reimplemented from DtExerciseConnInitializer.

virtual double DtVrlApplicationInitializer::rprFomVersion ( ) const

virtual

Returns the RPR FOM Version. See above description.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::saveFile ( const DtString &  filename )

virtual

Save configuration settings to a .xml file.

virtual bool DtVrlApplicationInitializer::sendFedTime ( ) const

virtual

Get the send fed time flag. See above description.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::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 from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setExceptionOnRtiCompilerMismatch ( bool  yesNo )

virtual

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

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setExecName ( const DtString &  name )

virtual

Set/Get the execution name.

Reimplemented from DtExerciseConnInitializer.

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

virtual

HLA Evolved only.

Set/Get the federate name.

Reimplemented from DtExerciseConnInitializer.

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

virtual

Set/Get the federate type.

Reimplemented from DtExerciseConnInitializer.

void DtVrlApplicationInitializer::setFedFileName ( const DtString &  name )

virtual

Set/Get the fed file name.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setFomMapperInitData ( void *  data )

virtual

Get the FOM mapper initialization data.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setFomMapperLibName ( const DtString &  name )

virtual

Set/Get the DSO name.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::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 from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setLocalSettingsDesignator ( const DtString &  name )

virtual

HLA Evolved only.

Set/Get the local settings designator.

Reimplemented from DtExerciseConnInitializer.

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

virtual

Set/Get the MOM and Initialization Module (MIM) HLA Evolved only.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setPauseOnSaveRestore ( bool  yesNo )

virtual

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

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::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 from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setRprFomVersion ( double  version )

virtual

Set/Get the RPR FOM Version.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::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 from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setTimeStampType ( DtTimeStampType  relOrAbs )

virtual

Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).

Defaults to DtTimeStampRelative.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::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 from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setUseGeographicDdm ( bool  yesNo )

virtual

Sets the use geographic DDM flag.

Reimplemented from DtExerciseConnInitializer.

virtual DtTimeStampType DtVrlApplicationInitializer::timeStampType ( ) const

virtual

Get the time stamp type.

Reimplemented from DtExerciseConnInitializer.

virtual bool DtVrlApplicationInitializer::useAdvisories ( ) const

virtual

Get use of advisories.

Reimplemented from DtExerciseConnInitializer.

virtual bool DtVrlApplicationInitializer::useGeographicDdm ( ) const

virtual

Get the use geographic DDM flag.

Reimplemented from DtExerciseConnInitializer.

Member Data Documentation

int DtVrlApplicationInitializer::myArgc

protected

char** DtVrlApplicationInitializer::myArgv

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarDestroyFedExec

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarExecName

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarFederateName

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarFederateType

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarFedFileName

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarFomMapperInitData

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarFomMapperLibName

protected

DtMultiConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarFomModules

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarGenericAttributes

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarIgnoreAdvisories

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarLocalSettingsDesignator

protected

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarMimModule

protected

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarNotifyLevel

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarPauseOnSaveRestore

protected

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarRprFomRevision

protected

DtConfigVariable<double> DtVrlApplicationInitializer::myConfigVarRprFomVersion

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarRtiCompilerCheck

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarSendFedTime

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarUseAbsoluteTimestamps

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarUseAdvisories

protected

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarUseGeographicDdm

protected

DtVariableGroup DtVrlApplicationInitializer::myHlaConnection

protected

int DtVrlApplicationInitializer::myMtlDestroyFedExec

protected

DtMtlEnvironment* DtVrlApplicationInitializer::myMtlEnv

protected

int DtVrlApplicationInitializer::myMtlPauseOnSaveRestore

protected

int DtVrlApplicationInitializer::myMtlSendFedTime

protected

int DtVrlApplicationInitializer::myMtlUseAbsoluteTimeStamps

protected

int DtVrlApplicationInitializer::myMtlUseAdvisories

protected

int DtVrlApplicationInitializer::myMtlUseGeographicDdm

protected

DtApplicationSettings DtVrlApplicationInitializer::mySettings

protected

---

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

• exerciseConnInitializerHLA.h