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:

List of all members.

Public Member Functions
	DtVrlApplicationInitializer (int argc, char *argv[], const DtString &appName, const DtString &version=DtExerciseConn::vrlinkVersion())
virtual	~DtVrlApplicationInitializer ()
virtual void	parseCmdLine ()
virtual void	loadFile (const DtString &fileName)
	Load an .mtl or .xml file.
virtual void	saveFile (const DtString &filename)
	Saves the state of application settings to a specified .xml file.
virtual int	argc () const
	Returns the argument count passed to the constructor.
virtual char **	argv () const
	Returns a pointer to the variable argument list passed to the constructor.
virtual void	setPort (int port)
	Sets the port.
virtual int	port () const
	Returns the port.
virtual void	setExerciseId (int id)
	Sets the exercise ID.
virtual int	exerciseId () const
	Returns the exercise ID.
virtual void	setApplicationNumber (int num)
	Sets the application number.
virtual int	applicationNumber () const
	Returns the application number.
virtual void	setSiteId (int id)
	Sets the site ID.
virtual int	siteId () const
	Returns the site ID.
virtual void	setDestinationAddress (const DtString &address)
	Sets the destination address Same as above but takes address as a string.
virtual DtString	destinationAddress () const
	Returns the destination address.
virtual void	setNotifyLevel (int level)
	Sets the notify level.
virtual void	setSendBufferSize (int numBytes)
	Set the send buffer size.
virtual int	sendBufferSize () const
	Get the send buffer size.
virtual void	setReceiveBufferSize (int numBytes)
	Set the receive buffer size.
virtual int	receiveBufferSize () const
	Get the receive buffer size.
virtual void	setUseAsynchIO (bool on)
	Sets the use of asynchronous I/O.
virtual bool	useAsynchIO () const
	Returns the use of asynchronous I/O.
virtual void	setMulticastTtl (int ttl)
	Sets the network time to live for multicast traffic.
virtual int	multicastTtl () const
	Returns the network time to live for multicast traffic.
virtual void	setTimeStampType (DtTimeStampType relOrAbs)
	Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).
virtual DtTimeStampType	timeStampType () const
	Get the time stamp type.
virtual const std::vector < DtString > &	multicastAddresses () const
virtual void	setUseIpv6 (bool val)
virtual bool	useIpv6 () const
virtual void	setSuppressSelfReflect (bool yesNo)
	Set the suppression of reflection DIS PDU's. Off by default.
virtual bool	suppressSelfReflect () const
	Returns whether the application should not self reflect.
virtual void	setDeviceAddress (const DtString &devAddr)
	Set the device to use for the DIS connection.
virtual DtString	deviceAddress () const
	Returns the device address to use.
virtual void	setSubnetMask (const DtString &mask)
	Set the subnet mask to use for the DIS connection.
virtual DtString	subnetMask () const
	Returns the subnet mask to use.
Protected Member Functions
virtual void	initializeMtlParams ()
virtual void	loadMtlFile (const DtString &fileName)
Protected Attributes
int	myArgc
char **	myArgv
DtMtlEnvironment *	myMtlEnv
DtApplicationSettings	mySettings
DtConfigVariable< int >	myNotifyLevel
DtVariableGroup	myDisConnection
DtConfigVariable< int >	myConfigVarPort
DtConfigVariable< int >	myConfigVarExerciseId
DtConfigVariable< int >	myConfigVarSiteNumber
DtConfigVariable< int >	myConfigVarApplicationNumber
DtConfigVariable< int >	myConfigVarDisVersion
DtConfigVariable< DtString >	myConfigVarDestinationAddress
DtConfigVariable< int >	myConfigVarSendBufferSize
DtConfigVariable< int >	myConfigVarReceiveBufferSize
DtConfigVariable< bool >	myConfigVarUseAsyncIo
DtConfigVariable< bool >	myConfigVarUseIpv6
DtConfigVariable< bool >	myConfigVarSuppressSelfReflect
DtConfigVariable< bool >	myConfigVarUseAbsoluteTimestamps
DtConfigVariable< int >	myConfigVarMulticastTtl
DtMultiConfigVariable< DtString >	myConfigVarMulticastAddresses
DtConfigVariable< DtString >	myConfigVarDeviceAddress
DtConfigVariable< DtString >	myConfigVarSubnetMask
DtInetAddr	myCachedDestAddr
int	myMtlUseAsynchronousIO
int	myMtlUseAbsoluteTimeStamps
int	myMtlUseIpv6
int	myMtlSuppressSelfReflect

---

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()
	)

virtual DtVrlApplicationInitializer::~DtVrlApplicationInitializer

(

)

[virtual]

---

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 passed to the constructor.

virtual char** DtVrlApplicationInitializer::argv

(

)

const [virtual]

Returns a pointer to the variable argument list passed to the constructor.

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 int DtVrlApplicationInitializer::exerciseId

(

)

const [virtual]

Returns the exercise ID.

Reimplemented from DtExerciseConnInitializer.

virtual void DtVrlApplicationInitializer::initializeMtlParams

(

)

[protected, virtual]

Reimplemented in 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

)

[protected, virtual]

Reimplemented in 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 void DtVrlApplicationInitializer::parseCmdLine

(

)

[virtual]

Reimplemented in 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::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::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::setNotifyLevel

(

int

level

)

[virtual]

Sets the notify level.

Reimplemented from DtExerciseConnInitializer.

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 void DtVrlApplicationInitializer::setUseAsynchIO

(

bool

on

)

[virtual]

Sets the use of asynchronous I/O.

Reimplemented from DtExerciseConnInitializer.

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

(

)

const [virtual]

Reimplemented from DtExerciseConnInitializer.

---

Member Data Documentation

int DtVrlApplicationInitializer::myArgc [protected]

char** DtVrlApplicationInitializer::myArgv [protected]

DtInetAddr DtVrlApplicationInitializer::myCachedDestAddr [mutable, protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarApplicationNumber [protected]

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarDestinationAddress [protected]

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarDeviceAddress [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarDisVersion [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarExerciseId [protected]

DtMultiConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarMulticastAddresses [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarMulticastTtl [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarPort [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarReceiveBufferSize [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarSendBufferSize [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myConfigVarSiteNumber [protected]

DtConfigVariable<DtString> DtVrlApplicationInitializer::myConfigVarSubnetMask [protected]

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarSuppressSelfReflect [protected]

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarUseAbsoluteTimestamps [protected]

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarUseAsyncIo [protected]

DtConfigVariable<bool> DtVrlApplicationInitializer::myConfigVarUseIpv6 [protected]

DtVariableGroup DtVrlApplicationInitializer::myDisConnection [protected]

DtMtlEnvironment* DtVrlApplicationInitializer::myMtlEnv [protected]

int DtVrlApplicationInitializer::myMtlSuppressSelfReflect [protected]

int DtVrlApplicationInitializer::myMtlUseAbsoluteTimeStamps [protected]

int DtVrlApplicationInitializer::myMtlUseAsynchronousIO [protected]

Reimplemented in DtLauncherInitializer.

int DtVrlApplicationInitializer::myMtlUseIpv6 [protected]

DtConfigVariable<int> DtVrlApplicationInitializer::myNotifyLevel [protected]

DtApplicationSettings DtVrlApplicationInitializer::mySettings [protected]

---

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

• dExConnInit.h