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 &defaultConfigFilePath=DtDefaultConfigFile, const DtString &version=DtExerciseConnInitializer::vrlinkVersion())
	Constructor. More...
virtual	~DtVrlApplicationInitializer ()
	Destructor. More...
	DtVrlApplicationInitializer (const DtVrlApplicationInitializer &orig)
	Copy Constructor. More...
DtVrlApplicationInitializer &	operator= (const DtVrlApplicationInitializer &orig)
	Assignment Operator. More...
virtual void	parseCmdLine ()
virtual void	loadFile (const DtString &fileName)
	Load an .mtl or .xml file. More...
virtual void	saveFile (const DtString &filename)
	Saves the state of application settings to a specified .xml file. More...
virtual void	setArgc (int)
	Note if explicitly setting argc and argv, you must do this before parseCmdLine() or the behavior is undefined. More...
virtual int	argc () const
	Returns the argument count. More...
virtual void	setArgv (char **)
	Note if explicitly setting argv and argc, you must do this before parseCmdLine() or the behavior is undefined. More...
virtual char **	argv () const
	Returns a pointer to the variable argument list. More...
virtual DtExerciseConnConfig *	exerciseConnectionConfig ()
	Get the exercise connection configuration. More...
virtual const DtExerciseConnConfig &	exConnConfig () const
	Get the exercise connection configuration. More...
virtual DtApplicationSettings &	settings ()
	Get the application settings. More...
virtual const int	disVersion () const
	Get the disVersion. More...
virtual void	setPort (int port)
	Sets the port. More...
virtual int	port () const
	Returns the port. More...
virtual void	setExerciseId (int id)
	Sets the exercise ID. More...
virtual int	exerciseId () const
	Returns the exercise ID. More...
virtual void	setApplicationNumber (int num)
	Sets the application number. More...
virtual int	applicationNumber () const
	Returns the application number. More...
virtual void	setSiteId (int id)
	Sets the site ID. More...
virtual int	siteId () const
	Returns the site ID. More...
virtual void	setDestinationAddress (const DtString &address)
	Sets the destination address Same as above but takes address as a string. More...
virtual DtString	destinationAddress () const
	Returns the destination address. More...
virtual void	setNotifyLevel (int level)
	Sets the notify level. More...
virtual void	setNotifyFileLevel (int level)
	Sets the notify level for file output, if the filename has been set. More...
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. More...
virtual DtString	notifyFilename () const
virtual void	setSendBufferSize (int numBytes)
	Set the send buffer size. More...
virtual int	sendBufferSize () const
	Get the send buffer size. More...
virtual void	setReceiveBufferSize (int numBytes)
	Set the receive buffer size. More...
virtual int	receiveBufferSize () const
	Get the receive buffer size. More...
virtual void	setUseAsynchIO (bool on)
	Sets the use of asynchronous I/O. More...
virtual bool	useAsynchIO () const
	Returns the use of asynchronous I/O. More...
virtual void	setMulticastTtl (int ttl)
	Sets the network time to live for multicast traffic. More...
virtual int	multicastTtl () const
	Returns the network time to live for multicast traffic. More...
virtual void	setTimeStampType (DtTimeStampType relOrAbs)
	Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative). More...
virtual DtTimeStampType	timeStampType () const
	Get the time stamp type. More...
virtual void	setMulticastAddresses (const std::vector< DtString > &addresses)
virtual const std::vector < DtString > &	multicastAddresses () const
virtual void	setUseIpv6 (bool val)
virtual bool	useIpv6 () const
virtual void	setUseDis5Timestamps (bool onOff)
	Set/Get the whether to use DIS 5 timestamps. More...
virtual bool	useDis5TimeStamps () const
virtual void	setSuppressSelfReflect (bool yesNo)
	Set the suppression of reflection DIS PDU's. Off by default. More...
virtual bool	suppressSelfReflect () const
	Returns whether the application should not self reflect. More...
virtual void	setDeviceAddress (const DtString &devAddr)
	Set the device to use for the DIS connection. More...
virtual DtString	deviceAddress () const
	Returns the device address to use. More...
virtual void	setSubnetMask (const DtString &mask)
	Set the subnet mask to use for the DIS connection. More...
virtual DtString	subnetMask () const
	Returns the subnet mask to use. More...
virtual void	setAttributePduStrategy (DtAttributePduStrategy strat)
	Set whether to couple the attribute PDU. More...
virtual DtAttributePduStrategy	attributePduStrategy () const
	Returns whether to couple the attribute PDU. More...
virtual void	setOutputInterval (double period)
	Set print output interval. More...
virtual double	outputInterval () const
	Get print output interval. More...
Public Member Functions inherited from DtExerciseConnInitializer
	DtExerciseConnInitializer ()
	Constructor. More...
virtual	~DtExerciseConnInitializer ()
	Destructor. More...
	DtExerciseConnInitializer (const DtExerciseConnInitializer &orig)
	Copy Constructor. More...
DtExerciseConnInitializer &	operator= (const DtExerciseConnInitializer &orig)
	Assignment Operator. More...
virtual void	setSocket (DtDisSocket *sock)
	Sets the socket. More...
virtual DtDisSocket *	socket () const
	Returns the socket. More...
virtual bool	dis5Timestamps () const
	Returns myDis5Timestamps setting. More...
virtual void	setDis5Timestamps (bool onOff)
	sets the myDis5Timestamps variable More...
virtual void	setDisVersionToSend (int version)
	Sets the DIS version to send. More...

Protected Member Functions
virtual void	initializeFileLogging ()
	Start file logging. Done automatically by the reader. More...
virtual void	initializeConnectionConfigVariables ()
	Initialize Config Variables with names and shortcuts. More...
virtual void	initializeMtlParams ()
	Initialize the MTL parameters before loading a configuration file. More...
virtual void	loadMtlFile (const DtString &fileName)
	Used to load configuration when configuration file is MTL. More...

Protected Attributes
int	myArgc
char **	myArgv
DtExerciseConnConfig	myExConnConfig
DtMtlEnvironment *	myMtlEnv
DtMultiConfigVariable< DtString >	myMultipleConfigFiles
DtInetAddr	myCachedDestAddr
int	myMtlUseAsynchronousIO
int	myMtlUseAbsoluteTimeStamps
int	myMtlUseIpv6
int	myMtlSuppressSelfReflect

Additional Inherited Members
Static Public Member Functions inherited from DtExerciseConnInitializer
static DtString	vrlinkVersion ()
	Returns a string indicating the VR-Link version number. More...

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 &	defaultConfigFilePath = DtDefaultConfigFile,
		const DtString &	version = DtExerciseConnInitializer::vrlinkVersion()
	)

Constructor.

virtual DtVrlApplicationInitializer::~DtVrlApplicationInitializer ( )

virtual

Destructor.

DtVrlApplicationInitializer::DtVrlApplicationInitializer

(

const DtVrlApplicationInitializer &

orig

)

Copy Constructor.

Member Function Documentation

virtual int DtVrlApplicationInitializer::applicationNumber ( ) const

virtual

Returns the application number.

Reimplemented from DtExerciseConnInitializer.

virtual int DtVrlApplicationInitializer::argc ( ) const

virtual

Returns the argument count.

virtual char** DtVrlApplicationInitializer::argv ( ) const

virtual

Returns a pointer to the variable argument list.

virtual DtAttributePduStrategy DtVrlApplicationInitializer::attributePduStrategy ( ) const

virtual

Returns whether to couple the attribute PDU.

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::destinationAddress ( ) const

virtual

Returns the destination address.

Sets the destination address

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::deviceAddress ( ) const

virtual

Returns the device address to use.

Reimplemented from DtExerciseConnInitializer.

virtual const int DtVrlApplicationInitializer::disVersion ( ) const

virtual

Get the disVersion.

virtual const DtExerciseConnConfig& DtVrlApplicationInitializer::exConnConfig ( ) const

virtual

Get the exercise connection configuration.

virtual DtExerciseConnConfig* DtVrlApplicationInitializer::exerciseConnectionConfig ( )

virtual

Get the exercise connection configuration.

virtual int DtVrlApplicationInitializer::exerciseId ( ) const

virtual

Returns the exercise ID.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::initializeConnectionConfigVariables ( )

protectedvirtual

Initialize Config Variables with names and shortcuts.

virtual void DtVrlApplicationInitializer::initializeFileLogging ( )

protectedvirtual

Start file logging. Done automatically by the reader.

virtual void DtVrlApplicationInitializer::initializeMtlParams ( )

protectedvirtual

Initialize the MTL parameters before loading a configuration file.

Reimplemented in DtF18Initializer, DtLauncherInitializer, and DtF18Initializer.

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

virtual

Load an .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 )

protectedvirtual

Used to load configuration when configuration file is MTL.

Reimplemented in DtF18Initializer, and DtF18Initializer.

virtual const std::vector<DtString>& DtVrlApplicationInitializer::multicastAddresses ( ) const

virtual

Reimplemented from DtExerciseConnInitializer.

virtual int DtVrlApplicationInitializer::multicastTtl ( ) const

virtual

Returns the network time to live for multicast traffic.

see setMulticastTtl

Reimplemented from DtExerciseConnInitializer.

virtual int DtVrlApplicationInitializer::notifyFileLevel ( ) const

virtual

virtual DtString DtVrlApplicationInitializer::notifyFilename ( ) const

virtual

DtVrlApplicationInitializer& DtVrlApplicationInitializer::operator=

(

const DtVrlApplicationInitializer &

orig

)

Assignment Operator.

virtual double DtVrlApplicationInitializer::outputInterval ( ) const

virtual

Get print output interval.

virtual void DtVrlApplicationInitializer::parseCmdLine ( )

virtual

Reimplemented in DtF18Initializer, DtF18Initializer, and DtLauncherInitializer.

virtual int DtVrlApplicationInitializer::port ( ) const

virtual

Returns the port.

Reimplemented from DtExerciseConnInitializer.

virtual int DtVrlApplicationInitializer::receiveBufferSize ( ) const

virtual

Get the receive buffer size.

Reimplemented from DtExerciseConnInitializer.

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

virtual

Saves the state of application settings to a specified .xml file.

virtual int DtVrlApplicationInitializer::sendBufferSize ( ) const

virtual

Get the send buffer size.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setApplicationNumber ( int  num )

virtual

Sets the application number.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setArgc ( int  )

virtual

Note if explicitly setting argc and argv, you must do this before parseCmdLine() or the behavior is undefined.

virtual void DtVrlApplicationInitializer::setArgv ( char **  )

virtual

Note if explicitly setting argv and argc, you must do this before parseCmdLine() or the behavior is undefined.

virtual void DtVrlApplicationInitializer::setAttributePduStrategy ( DtAttributePduStrategy  strat )

virtual

Set whether to couple the attribute PDU.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setDestinationAddress ( const DtString &  addr )

virtual

Sets the destination address Same as above but takes address as a string.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setDeviceAddress ( const DtString &  devAddr )

virtual

Set the device to use for the DIS connection.

Will use the broadcast address of the device and bind to that device.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setExerciseId ( int  id )

virtual

Sets the exercise ID.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setMulticastAddresses ( const std::vector< DtString > &  addresses )

virtual

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setMulticastTtl ( int  ttl )

virtual

Sets the network time to live for multicast traffic.

This is the maximum number of hops allowed before the network drops the message.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setNotifyFileLevel ( int  level )

virtual

Sets the notify level for file output, if the filename has been set.

virtual void DtVrlApplicationInitializer::setNotifyFilename ( const DtString &  file )

virtual

Setting this will allow notifications to be sent to a file as well as the console.

virtual void DtVrlApplicationInitializer::setNotifyLevel ( int  level )

virtual

Sets the notify level.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setOutputInterval ( double  period )

virtual

Set print output interval.

Set interval between printing output. Defaults to 10 seconds;

virtual void DtVrlApplicationInitializer::setPort ( int  port )

virtual

Sets the port.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setReceiveBufferSize ( int  numBytes )

virtual

Set the receive buffer size.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setSendBufferSize ( int  numBytes )

virtual

Set the send buffer size.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setSiteId ( int  id )

virtual

Sets the site ID.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setSubnetMask ( const DtString &  mask )

virtual

Set the subnet mask to use for the DIS connection.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setSuppressSelfReflect ( bool  yesNo )

virtual

Set the suppression of reflection DIS PDU's. Off by default.

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 DtApplicationSettings& DtVrlApplicationInitializer::settings ( )

virtual

Get the application settings.

virtual void DtVrlApplicationInitializer::setUseAsynchIO ( bool  on )

virtual

Sets the use of asynchronous I/O.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::setUseDis5Timestamps ( bool  onOff )

virtual

Set/Get the whether to use DIS 5 timestamps.

virtual void DtVrlApplicationInitializer::setUseIpv6 ( bool  val )

virtual

Reimplemented from DtExerciseConnInitializer.

virtual int DtVrlApplicationInitializer::siteId ( ) const

virtual

Returns the site ID.

Reimplemented from DtExerciseConnInitializer.

virtual DtString DtVrlApplicationInitializer::subnetMask ( ) const

virtual

Returns the subnet mask to use.

Reimplemented from DtExerciseConnInitializer.

virtual bool DtVrlApplicationInitializer::suppressSelfReflect ( ) const

virtual

Returns whether the application should not self reflect.

Reimplemented from DtExerciseConnInitializer.

virtual DtTimeStampType DtVrlApplicationInitializer::timeStampType ( ) const

virtual

Get the time stamp type.

Reimplemented from DtExerciseConnInitializer.

virtual bool DtVrlApplicationInitializer::useAsynchIO ( ) const

virtual

Returns the use of asynchronous I/O.

Reimplemented from DtExerciseConnInitializer.

virtual bool DtVrlApplicationInitializer::useDis5TimeStamps ( ) const

virtual

virtual bool DtVrlApplicationInitializer::useIpv6 ( ) const

virtual

Reimplemented from DtExerciseConnInitializer.

Member Data Documentation

int DtVrlApplicationInitializer::myArgc

protected

char** DtVrlApplicationInitializer::myArgv

protected

DtInetAddr DtVrlApplicationInitializer::myCachedDestAddr

mutableprotected

DtExerciseConnConfig DtVrlApplicationInitializer::myExConnConfig

protected

DtMtlEnvironment* DtVrlApplicationInitializer::myMtlEnv

protected

int DtVrlApplicationInitializer::myMtlSuppressSelfReflect

protected

int DtVrlApplicationInitializer::myMtlUseAbsoluteTimeStamps

protected

int DtVrlApplicationInitializer::myMtlUseAsynchronousIO

protected

int DtVrlApplicationInitializer::myMtlUseIpv6

protected

DtMultiConfigVariable<DtString> DtVrlApplicationInitializer::myMultipleConfigFiles

protected

---

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

• exerciseConnInitializerDIS.h