makVrv::DtCigiConnectionInitializer Class Reference

This class initializes the CIGI driver. More...

Public Types
enum	TransportType { BestEffort = 0, Reliable_Client = 1, Reliable_Server = 2 }
enum	ConnectionMode { SynchronousSingleThreaded, SynchronousMultiThreaded, Asynchronous }

Public Member Functions
	DtCigiConnectionInitializer ()
	Constructor.
	DtCigiConnectionInitializer (const DtCigiConnectionInitializer &orig)
	Copy Constructor.
virtual	~DtCigiConnectionInitializer ()
	Destructor.
DtCigiConnectionInitializer &	operator= (const DtCigiConnectionInitializer &orig)
	Assignment Operator.
std::string	cigiVersion () const
	Returns the CIGI Version in string form.
virtual void	setCigiVersion (const std::string &version)
	Set the CIGI version string.
std::string	cigiMappingsName () const
	Returns the name of the CIGI mappings to use.
virtual void	setCigiMappingsName (const std::string &name)
	Sets the name of the CIGI mappings to use.
std::string	deviceAddress () const
	Returns the network device address for host communication.
virtual void	setDeviceAddress (const std::string &address)
	Sets the network device address for host communication.
std::string	hostIpAddress () const
	Returns the IP address of the CIGI host.
virtual void	setHostIpAddress (const std::string &address)
	Sets the CIGI host's IP address.
unsigned	incomingBufferSize () const
	Returns the size of the incoming CIGI buffer.
virtual void	setIncomingBufferSize (unsigned nSize)
	Sets the buffer size for CIGI incoming message queue.
unsigned	listenPort () const
	Returns the network listen port.
virtual void	setListenPort (unsigned port)
	Set the network listen port.
unsigned	incomingBuffers () const
	Returns the number of incoming CIGI buffers.
virtual void	setNumIncomingBuffers (unsigned nNum)
	Sets the number of buffers for CIGI incoming message queue.
unsigned	outgoingBuffers () const
	Returns the number of outgoing CIGI buffers.
virtual void	setNumOutgoingBuffers (unsigned nNum)
	Sets the number of buffers for CIGI outgoing message queue.
unsigned	outgoingBufferSize () const
	Returns the size of the outgoing CIGI buffer.
virtual void	setOutgoingBufferSize (unsigned nSize)
	Sets the buffer size for CIGI outgoing message queue.
unsigned	packetBufferSize () const
	Returns the size of the receiving network buffer.
virtual void	setPacketBufferSize (unsigned nSize)
	Set size of receive packet buffer on network socket.
unsigned	sendPort () const
	Returns port being sent to.
virtual void	setSendPort (unsigned port)
	Set the Send to Host port.
virtual ConnectionMode	driverMode () const
	Returns the driver mode: Synchronous (multi/single threaded) or asynchronous.
virtual void	setDriverMode (ConnectionMode mode)
	Sets the driver mode. Saved in the config file as driverModeEnum.
virtual void	setDriverModeByString (const std::string &mode)
	This provides backward compatibility with driver configuration files the use the old driverMode parameter.
virtual TransportType	transportType () const
	Returns the transport type (best effort or reliable (client or server)).
virtual void	setTransportType (TransportType tType)
	Sets the transport type.
virtual bool	useSynchronousMode () const
	Returns whether we're using synchronous mode, based on the driver mode.
virtual void	setDriverFrequency (unsigned int hertz)
	Sets the driver frequency.
virtual unsigned int	driverFrequency () const
	Returns the driver frequency.
virtual void	setHostFrequency (unsigned int hertz)
	Sets the host frequency.
virtual unsigned int	hostFrequency () const
	Returns the host frequency.
virtual float	pauseAfterConnectTime () const
	Returns the amount of time the connection should sleep after connect, in seconds.
virtual void	setPauseAfterConnectTime (float pauseSeconds)
	Set the amount of time we pause after connect.

Protected Attributes
std::string	myCigiVersion
std::string	myDeviceAddress
std::string	myHostIpAddress
std::string	myEntityMappingName
unsigned	myIncomingBufferSize
unsigned	myListenPort
unsigned	myNumIncomingBuffers
unsigned	myNumOutgoingBuffers
unsigned	myOutgoingBufferSize
unsigned	myPacketBufferSize
unsigned	mySendPort
ConnectionMode	myDriverMode
TransportType	myTransportType
unsigned int	myDriverFrequency
unsigned int	myHostFrequency
float	myPauseAfterConnectTime

Detailed Description

This class initializes the CIGI driver.

Member Enumeration Documentation

enum makVrv::DtCigiConnectionInitializer::TransportType

Enumerator:

BestEffort
Reliable_Client
Reliable_Server

enum makVrv::DtCigiConnectionInitializer::ConnectionMode

Enumerator:

SynchronousSingleThreaded
SynchronousMultiThreaded
Asynchronous

Constructor & Destructor Documentation

makVrv::DtCigiConnectionInitializer::DtCigiConnectionInitializer

(

)

Constructor.

makVrv::DtCigiConnectionInitializer::DtCigiConnectionInitializer

(

const DtCigiConnectionInitializer &

orig

)

Copy Constructor.

virtual makVrv::DtCigiConnectionInitializer::~DtCigiConnectionInitializer ( )

virtual

Destructor.

Member Function Documentation

DtCigiConnectionInitializer& makVrv::DtCigiConnectionInitializer::operator=

(

const DtCigiConnectionInitializer &

orig

)

Assignment Operator.

std::string makVrv::DtCigiConnectionInitializer::cigiVersion ( ) const

inline

Returns the CIGI Version in string form.

References myCigiVersion.

virtual void makVrv::DtCigiConnectionInitializer::setCigiVersion ( const std::string &  version )

virtual

Set the CIGI version string.

std::string makVrv::DtCigiConnectionInitializer::cigiMappingsName

(

)

const

Returns the name of the CIGI mappings to use.

virtual void makVrv::DtCigiConnectionInitializer::setCigiMappingsName ( const std::string &  name )

virtual

Sets the name of the CIGI mappings to use.

std::string makVrv::DtCigiConnectionInitializer::deviceAddress ( ) const

inline

Returns the network device address for host communication.

References myDeviceAddress.

virtual void makVrv::DtCigiConnectionInitializer::setDeviceAddress ( const std::string &  address )

virtual

Sets the network device address for host communication.

std::string makVrv::DtCigiConnectionInitializer::hostIpAddress ( ) const

inline

Returns the IP address of the CIGI host.

References myHostIpAddress.

virtual void makVrv::DtCigiConnectionInitializer::setHostIpAddress ( const std::string &  address )

virtual

Sets the CIGI host's IP address.

unsigned makVrv::DtCigiConnectionInitializer::incomingBufferSize ( ) const

inline

Returns the size of the incoming CIGI buffer.

References myIncomingBufferSize.

virtual void makVrv::DtCigiConnectionInitializer::setIncomingBufferSize ( unsigned  nSize )

virtual

Sets the buffer size for CIGI incoming message queue.

unsigned makVrv::DtCigiConnectionInitializer::listenPort ( ) const

inline

Returns the network listen port.

References myListenPort.

virtual void makVrv::DtCigiConnectionInitializer::setListenPort ( unsigned  port )

virtual

Set the network listen port.

unsigned makVrv::DtCigiConnectionInitializer::incomingBuffers ( ) const

inline

Returns the number of incoming CIGI buffers.

References myNumIncomingBuffers.

virtual void makVrv::DtCigiConnectionInitializer::setNumIncomingBuffers ( unsigned  nNum )

virtual

Sets the number of buffers for CIGI incoming message queue.

unsigned makVrv::DtCigiConnectionInitializer::outgoingBuffers ( ) const

inline

Returns the number of outgoing CIGI buffers.

References myNumOutgoingBuffers.

virtual void makVrv::DtCigiConnectionInitializer::setNumOutgoingBuffers ( unsigned  nNum )

virtual

Sets the number of buffers for CIGI outgoing message queue.

unsigned makVrv::DtCigiConnectionInitializer::outgoingBufferSize ( ) const

inline

Returns the size of the outgoing CIGI buffer.

References myOutgoingBufferSize.

virtual void makVrv::DtCigiConnectionInitializer::setOutgoingBufferSize ( unsigned  nSize )

virtual

Sets the buffer size for CIGI outgoing message queue.

unsigned makVrv::DtCigiConnectionInitializer::packetBufferSize ( ) const

inline

Returns the size of the receiving network buffer.

References myPacketBufferSize.

virtual void makVrv::DtCigiConnectionInitializer::setPacketBufferSize ( unsigned  nSize )

virtual

Set size of receive packet buffer on network socket.

unsigned makVrv::DtCigiConnectionInitializer::sendPort ( ) const

inline

Returns port being sent to.

References mySendPort.

virtual void makVrv::DtCigiConnectionInitializer::setSendPort ( unsigned  port )

virtual

Set the Send to Host port.

virtual ConnectionMode makVrv::DtCigiConnectionInitializer::driverMode ( ) const

virtual

Returns the driver mode: Synchronous (multi/single threaded) or asynchronous.

virtual void makVrv::DtCigiConnectionInitializer::setDriverMode ( ConnectionMode  mode )

virtual

Sets the driver mode. Saved in the config file as driverModeEnum.

virtual void makVrv::DtCigiConnectionInitializer::setDriverModeByString ( const std::string &  mode )

virtual

This provides backward compatibility with driver configuration files the use the old driverMode parameter.

virtual TransportType makVrv::DtCigiConnectionInitializer::transportType ( ) const

virtual

Returns the transport type (best effort or reliable (client or server)).

virtual void makVrv::DtCigiConnectionInitializer::setTransportType ( TransportType  tType )

virtual

Sets the transport type.

virtual bool makVrv::DtCigiConnectionInitializer::useSynchronousMode ( ) const

virtual

Returns whether we're using synchronous mode, based on the driver mode.

virtual void makVrv::DtCigiConnectionInitializer::setDriverFrequency ( unsigned int  hertz )

virtual

Sets the driver frequency.

virtual unsigned int makVrv::DtCigiConnectionInitializer::driverFrequency ( ) const

virtual

Returns the driver frequency.

virtual void makVrv::DtCigiConnectionInitializer::setHostFrequency ( unsigned int  hertz )

virtual

Sets the host frequency.

Used for detecting overload conditions when using Asynchronous driver mode (in synchronous mode, host frequency is assumed to be the driver frequency

virtual unsigned int makVrv::DtCigiConnectionInitializer::hostFrequency ( ) const

virtual

Returns the host frequency.

virtual float makVrv::DtCigiConnectionInitializer::pauseAfterConnectTime ( ) const

virtual

Returns the amount of time the connection should sleep after connect, in seconds.

Users who autostart multiple drivers may have problems with querying the network device for the default address when no pause is provided - default is 0.

virtual void makVrv::DtCigiConnectionInitializer::setPauseAfterConnectTime ( float  pauseSeconds )

virtual

Set the amount of time we pause after connect.

Member Data Documentation

std::string makVrv::DtCigiConnectionInitializer::myCigiVersion

protected

Referenced by cigiVersion().

std::string makVrv::DtCigiConnectionInitializer::myDeviceAddress

protected

Referenced by deviceAddress().

std::string makVrv::DtCigiConnectionInitializer::myHostIpAddress

protected

Referenced by hostIpAddress().

std::string makVrv::DtCigiConnectionInitializer::myEntityMappingName

protected

unsigned makVrv::DtCigiConnectionInitializer::myIncomingBufferSize

protected

Referenced by incomingBufferSize().

unsigned makVrv::DtCigiConnectionInitializer::myListenPort

protected

Referenced by listenPort().

unsigned makVrv::DtCigiConnectionInitializer::myNumIncomingBuffers

protected

Referenced by incomingBuffers().

unsigned makVrv::DtCigiConnectionInitializer::myNumOutgoingBuffers

protected

Referenced by outgoingBuffers().

unsigned makVrv::DtCigiConnectionInitializer::myOutgoingBufferSize

protected

Referenced by outgoingBufferSize().

unsigned makVrv::DtCigiConnectionInitializer::myPacketBufferSize

protected

Referenced by packetBufferSize().

unsigned makVrv::DtCigiConnectionInitializer::mySendPort

protected

Referenced by sendPort().

ConnectionMode makVrv::DtCigiConnectionInitializer::myDriverMode

protected

TransportType makVrv::DtCigiConnectionInitializer::myTransportType

protected

unsigned int makVrv::DtCigiConnectionInitializer::myDriverFrequency

protected

unsigned int makVrv::DtCigiConnectionInitializer::myHostFrequency

protected

float makVrv::DtCigiConnectionInitializer::myPauseAfterConnectTime

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCigi/DtCigiConnectionInitializer.h