Instances of DtVrlApplicationInitializer are used to initialize the exercise connection with command line arguments. More...

Inheritance diagram for DtVrlApplicationInitializer:

Collaboration diagram for DtVrlApplicationInitializer:

List of all members.

Public Member Functions
	DtVrlApplicationInitializer (int argc, char *argv[], const DtString &appName, const DtString &version=DtExerciseConn::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	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.
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 >	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
int	myMtlUseAdvisories
int	myMtlUseGeographicDdm
int	myMtlUseAbsoluteTimeStamps
int	myMtlDestroyFedExec
int	myMtlSendFedTime

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 = `DtExerciseConn::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 DtString DtVrlApplicationInitializer::execName ( ) const [virtual]

Set the execution name.

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 ( ) [protected, virtual]

Reimplemented in DtLauncherInitializer, 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.

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, and DtLauncherInitializer.

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::setExecName ( const DtString & name ) [virtual]

Set/Get the execution 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::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.