VR-Link API Documentation for DIS
Public Member Functions | Private Attributes
DtExerciseConnInitializer Class Reference

Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization data. More...

+ Inheritance diagram for DtExerciseConnInitializer:
+ Collaboration diagram for DtExerciseConnInitializer:

List of all members.

Public Member Functions

 DtExerciseConnInitializer ()
 Constructor.
virtual ~DtExerciseConnInitializer ()
 Destructor.
 DtExerciseConnInitializer (const DtExerciseConnInitializer &orig)
 Copy Constructor.
DtExerciseConnInitializeroperator= (const DtExerciseConnInitializer &orig)
 Assignment Operator.
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 setSiteId (int id)
 Sets the site ID.
virtual int siteId () const
 Returns the site ID.
virtual void setApplicationNumber (int num)
 Sets the application number.
virtual int applicationNumber () const
 Returns the application number.
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 setDestinationAddress (const DtString &addr)
 Sets the destination address Same as above but takes address as a string.
virtual DtString destinationAddress () const
 Returns the destination address.
virtual void setSocket (DtDisSocket *sock)
 Sets the socket.
virtual DtDisSocketsocket () const
 Returns the socket.
virtual void setNotifyLevel (int level)
 Sets the notify level.
virtual void setDisVersionToSend (int version)
 Sets the DIS version to send.
virtual void setTimeStampType (DtTimeStampType relOrAbs)
 Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).
virtual DtTimeStampType timeStampType () const
 Get the time stamp type.
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 setUseIpv6 (bool val)
virtual bool useIpv6 () const
virtual void setMulticastTtl (int ttl)
 Set the mcast TTL.
virtual int multicastTtl () const
 Returns the multicast TTL.
virtual void setMulticastAddresses (const std::vector< DtString > &addresses)
virtual const std::vector
< DtString > & 
multicastAddresses () const
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.
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.

Private Attributes

int myPort
int myExerciseId
int mySiteId
int myApplicationNumber
bool myUseAsynchIO
DtTimeStampType myTimeStampType
int mySendBufferSize
int myReceiveBufferSize
int myMulticastTtl
std::vector< DtStringmyMulticastAddresses
bool myUseIpv6
bool mySuppressSelfReflect
DtString myDeviceAddress
DtString myDestinationAddress
DtString mySubnetMask
DtDisSocketmySocket

Detailed Description

Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization data.


Constructor & Destructor Documentation

Constructor.

Destructor.

Copy Constructor.


Member Function Documentation

virtual int DtExerciseConnInitializer::applicationNumber ( ) const [virtual]

Returns the application number.

Reimplemented in DtVrlApplicationInitializer.

Returns the destination address.

Sets the destination address

Reimplemented in DtVrlApplicationInitializer.

Returns the device address to use.

Reimplemented in DtVrlApplicationInitializer.

virtual int DtExerciseConnInitializer::exerciseId ( ) const [virtual]

Returns the exercise ID.

Reimplemented in DtVrlApplicationInitializer.

virtual const std::vector<DtString>& DtExerciseConnInitializer::multicastAddresses ( ) const [virtual]

Reimplemented in DtVrlApplicationInitializer.

virtual int DtExerciseConnInitializer::multicastTtl ( ) const [virtual]

Returns the multicast TTL.

Reimplemented in DtVrlApplicationInitializer.

DtExerciseConnInitializer& DtExerciseConnInitializer::operator= ( const DtExerciseConnInitializer orig)

Assignment Operator.

virtual int DtExerciseConnInitializer::port ( ) const [virtual]

Returns the port.

Reimplemented in DtVrlApplicationInitializer.

virtual int DtExerciseConnInitializer::receiveBufferSize ( ) const [virtual]

Get the receive buffer size.

Reimplemented in DtVrlApplicationInitializer.

virtual int DtExerciseConnInitializer::sendBufferSize ( ) const [virtual]

Get the send buffer size.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setApplicationNumber ( int  num) [virtual]

Sets the application number.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setDestinationAddress ( const DtString addr) [virtual]

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

Reimplemented in DtVrlApplicationInitializer.

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

virtual void DtExerciseConnInitializer::setDisVersionToSend ( int  version) [virtual]

Sets the DIS version to send.

virtual void DtExerciseConnInitializer::setExerciseId ( int  id) [virtual]

Sets the exercise ID.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setMulticastAddresses ( const std::vector< DtString > &  addresses) [virtual]
virtual void DtExerciseConnInitializer::setMulticastTtl ( int  ttl) [virtual]

Set the mcast TTL.

If changed from its default (-1), the multicast TTL will be changed from the system default to the specified number of hops

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setNotifyLevel ( int  level) [virtual]

Sets the notify level.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setPort ( int  port) [virtual]

Sets the port.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setReceiveBufferSize ( int  numBytes) [virtual]

Set the receive buffer size.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setSendBufferSize ( int  numBytes) [virtual]

Set the send buffer size.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setSiteId ( int  id) [virtual]

Sets the site ID.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setSocket ( DtDisSocket sock) [virtual]

Sets the socket.

If this is set from its default (0), the exercise connection will attempt to establish its connection using the specified socket

virtual void DtExerciseConnInitializer::setSubnetMask ( const DtString mask) [virtual]

Set the subnet mask to use for the DIS connection.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setSuppressSelfReflect ( bool  yesNo) [virtual]

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

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setTimeStampType ( DtTimeStampType  relOrAbs) [virtual]

Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).

Defaults to DtTimeStampRelative.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setUseAsynchIO ( bool  on) [virtual]

Sets the use of asynchronous I/O.

Reimplemented in DtVrlApplicationInitializer.

virtual void DtExerciseConnInitializer::setUseIpv6 ( bool  val) [virtual]

Reimplemented in DtVrlApplicationInitializer.

virtual int DtExerciseConnInitializer::siteId ( ) const [virtual]

Returns the site ID.

Reimplemented in DtVrlApplicationInitializer.

virtual DtDisSocket* DtExerciseConnInitializer::socket ( ) const [virtual]

Returns the socket.

virtual DtString DtExerciseConnInitializer::subnetMask ( ) const [virtual]

Returns the subnet mask to use.

Reimplemented in DtVrlApplicationInitializer.

virtual bool DtExerciseConnInitializer::suppressSelfReflect ( ) const [virtual]

Returns whether the application should not self reflect.

Reimplemented in DtVrlApplicationInitializer.

Get the time stamp type.

Reimplemented in DtVrlApplicationInitializer.

virtual bool DtExerciseConnInitializer::useAsynchIO ( ) const [virtual]

Returns the use of asynchronous I/O.

Reimplemented in DtVrlApplicationInitializer.

virtual bool DtExerciseConnInitializer::useIpv6 ( ) const [virtual]

Reimplemented in DtVrlApplicationInitializer.


Member Data Documentation


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)