VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtLauncherInitializer Class Reference

DtLauncherInitializer derives from DtVrlApplicationInitializer and describes how command line/MTL parameters could be added to a VR-Link application. More...

+ Inheritance diagram for DtLauncherInitializer:
+ Collaboration diagram for DtLauncherInitializer:

Public Member Functions

 DtLauncherInitializer (int argc, char *argv[])
 Default CTOR.
virtual ~DtLauncherInitializer ()
 Default DTOR.
virtual void parseCmdLine ()
 Parse the command line.
virtual void setLispFileName (const DtString &name)
virtual DtString lispFileName () const
virtual double refLatitude () const
virtual double refLongitude () const
virtual double lifeTime () const
virtual double erectorStartTime () const
virtual double erectorStopTime () const
virtual double missileSwapTime () const
virtual double fireTime () const
virtual double damageTime () const
virtual double missileMoveTime () const
virtual double missileStopTime () const
- Public Member Functions inherited from DtVrlApplicationInitializer
 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 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 setNotifyFileLevel (int level)
 Sets the notify level for file output, if the filename has been set.
virtual int notifyFileLevel () const
virtual void setNotifyFilename (const DtString &file)
 Setting this will allow notifications to be sent to a file as well as the console.
virtual DtString notifyFilename () const
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.
DtExerciseConnInitializeroperator= (const DtExerciseConnInitializer &orig)
 Assignment Operator.
virtual DtFomMapperfomMapper () 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 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 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 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 ()
 Register the MTL/Command Line parameters.
- Protected Member Functions inherited from DtVrlApplicationInitializer
virtual void initializeFileLogging ()
 Start file logging. Done automatically by the reader.

Protected Attributes

DtConfigVariable< DtStringmyLispFileName
 Command line arguments.
DtConfigVariable< doublemyLifeTime
DtConfigVariable< doublemyErectorStartTime
DtConfigVariable< doublemyErectorStopTime
DtConfigVariable< doublemyFireTime
DtConfigVariable< doublemyMissileSwapTime
DtConfigVariable< doublemyMissileMoveTime
DtConfigVariable< doublemyMissileStopTime
DtConfigVariable< doublemyDamageTime
int myMtlUseAsynchronousIO
double myRefLatitude
 here, because MTL does not support bool types
double myRefLongitude
- Protected Attributes inherited from DtVrlApplicationInitializer
int myArgc
char ** myArgv
DtMtlEnvironmentmyMtlEnv
DtApplicationSettings mySettings
DtConfigVariable< int > myConfigVarNotifyLevel
DtVariableGroup myHlaConnection
DtConfigVariable< DtStringmyConfigVarFederateType
DtConfigVariable< DtStringmyConfigVarExecName
DtConfigVariable< DtStringmyConfigVarFedFileName
DtConfigVariable< DtStringmyConfigVarFederateName
DtConfigVariable< DtStringmyConfigVarFomMapperLibName
DtConfigVariable< DtStringmyConfigVarFomMapperInitData
DtConfigVariable< doublemyConfigVarRprFomVersion
DtConfigVariable< int > myConfigVarRprFomRevision
DtConfigVariable< boolmyConfigVarUseAdvisories
DtConfigVariable< boolmyConfigVarIgnoreAdvisories
DtConfigVariable< boolmyConfigVarUseGeographicDdm
DtConfigVariable< boolmyConfigVarUseAbsoluteTimestamps
DtConfigVariable< boolmyConfigVarDestroyFedExec
DtConfigVariable< boolmyConfigVarSendFedTime
DtConfigVariable< boolmyConfigVarGenericAttributes
DtConfigVariable< boolmyConfigVarPauseOnSaveRestore
DtConfigVariable< boolmyConfigVarRtiCompilerCheck
DtConfigVariable< int > myConfigVarNotifyFileLevel
DtConfigVariable< DtStringmyConfigVarNotifyFilename
DtFilePrintermyLogFilePrinter
int myMtlUseAdvisories
int myMtlUseGeographicDdm
int myMtlUseAbsoluteTimeStamps
int myMtlDestroyFedExec
int myMtlSendFedTime
int myMtlPauseOnSaveRestore

Private Member Functions

 DtLauncherInitializer (const DtLauncherInitializer &other)
 Copy CTOR not implemented – Do Not copy.
DtLauncherInitializeroperator= (const DtLauncherInitializer &other)
 Assignment Operator not implemented – Do Not copy.

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

DtLauncherInitializer derives from DtVrlApplicationInitializer and describes how command line/MTL parameters could be added to a VR-Link application.

DtVrlApplicationInitializer contains default behavior for protocol specific parameters, while DtLauncherInitializer contains behavior particular to the F18 app parseCmdLine() parses the command line arguments specified in this class and DtVrlApplicationInitializer. loadMtlFile() can be called (defined in DtVrlApplicationInitializer) with an MTL file name. This will parse the MTL file specified and set those variables registered

Constructor & Destructor Documentation

DtLauncherInitializer::DtLauncherInitializer ( int  argc,
char *  argv[] 
)

Default CTOR.

virtual DtLauncherInitializer::~DtLauncherInitializer ( )
virtual

Default DTOR.

DtLauncherInitializer::DtLauncherInitializer ( const DtLauncherInitializer other)
private

Copy CTOR not implemented – Do Not copy.

Member Function Documentation

virtual double DtLauncherInitializer::damageTime ( ) const
virtual
virtual double DtLauncherInitializer::erectorStartTime ( ) const
virtual
virtual double DtLauncherInitializer::erectorStopTime ( ) const
virtual
virtual double DtLauncherInitializer::fireTime ( ) const
virtual
virtual void DtLauncherInitializer::initializeMtlParams ( )
protectedvirtual

Register the MTL/Command Line parameters.

Non-virtual since they are called from the constructor

Reimplemented from DtVrlApplicationInitializer.

virtual double DtLauncherInitializer::lifeTime ( ) const
virtual
virtual DtString DtLauncherInitializer::lispFileName ( ) const
virtual
virtual double DtLauncherInitializer::missileMoveTime ( ) const
virtual
virtual double DtLauncherInitializer::missileStopTime ( ) const
virtual
virtual double DtLauncherInitializer::missileSwapTime ( ) const
virtual
DtLauncherInitializer& DtLauncherInitializer::operator= ( const DtLauncherInitializer other)
private

Assignment Operator not implemented – Do Not copy.

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

virtual double DtLauncherInitializer::refLatitude ( ) const
virtual
virtual double DtLauncherInitializer::refLongitude ( ) const
virtual
virtual void DtLauncherInitializer::setLispFileName ( const DtString name)
virtual

Member Data Documentation

DtConfigVariable<double> DtLauncherInitializer::myDamageTime
protected
DtConfigVariable<double> DtLauncherInitializer::myErectorStartTime
protected
DtConfigVariable<double> DtLauncherInitializer::myErectorStopTime
protected
DtConfigVariable<double> DtLauncherInitializer::myFireTime
protected
DtConfigVariable<double> DtLauncherInitializer::myLifeTime
protected
DtConfigVariable<DtString> DtLauncherInitializer::myLispFileName
protected

Command line arguments.

DtConfigVariable<double> DtLauncherInitializer::myMissileMoveTime
protected
DtConfigVariable<double> DtLauncherInitializer::myMissileStopTime
protected
DtConfigVariable<double> DtLauncherInitializer::myMissileSwapTime
protected
int DtLauncherInitializer::myMtlUseAsynchronousIO
protected
double DtLauncherInitializer::myRefLatitude
protected

here, because MTL does not support bool types

double DtLauncherInitializer::myRefLongitude
protected

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

Document ID: Generated on Mon Jun 22 21:18:40 EDT 2020 from SVN revision 213785
Copyright © 2005-2018 MAK Technologies. All Rights Reserved (www.mak.com)