VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Public Attributes
makVrv::DtCigiConnectionInterface Class Referenceabstract

Abstract interface for a CIGI connection widget.

Inheritance diagram for makVrv::DtCigiConnectionInterface:
Inheritance graph
[legend]

Public Types

enum  ConnectionStatus {
  Disconnected, Connected, Connecting, Error,
  end_ConnectionStatus
}
 

Public Member Functions

virtual ~DtCigiConnectionInterface ()
 
virtual void setConnectionStatus (ConnectionStatus status)=0
 
virtual void setAutoConnectEnabled (bool enabled)=0
 
virtual void setCigiVersion (const std::string &version)=0
 
virtual void setCigiMappingsName (const std::string &name)=0
 
virtual void setDeviceIpAddress (const std::string &address)=0
 
virtual void setDeviceIpAddresses (const std::vector< std::string > &address)=0
 
virtual void setHostIpAddress (const std::string &address)=0
 
virtual void setIncomingBufferSize (unsigned nSize)=0
 
virtual void setListenPort (unsigned port)=0
 
virtual void setNumIncomingBuffers (unsigned nNum)=0
 
virtual void setNumOutgoingBuffers (unsigned nNum)=0
 
virtual void setOutgoingBufferSize (unsigned nSize)=0
 
virtual void setPacketBufferSize (unsigned nSize)=0
 
virtual void setSendPort (unsigned port)=0
 
virtual void setDriverMode (DtCigiConnectionInitializer::ConnectionMode mode)=0
 
virtual void setTransportType (int transportType)=0
 
virtual void setDriverFrequency (unsigned int hertz)=0
 
virtual void setHostFrequency (unsigned int hertz)=0
 
virtual void setEnableHostFrequency (bool enable)=0
 
virtual void setReturnConnectionObjectIds (bool returnDisIds)=0
 

Public Attributes

boost::signalslib::signal
< void(const std::string &)> 
signal_currentConnectionChanged
 
boost::signalslib::signal< void()> signal_connect
 
boost::signalslib::signal< void()> signal_disconnect
 
boost::signalslib::signal
< void(const std::string &)> 
signal_cigiVersionChanged
 
boost::signalslib::signal
< void(const std::string &)> 
signal_entityMappingNameChanged
 
boost::signalslib::signal
< void(const std::string &)> 
signal_hostIpChanged
 
boost::signalslib::signal
< void(const std::string &)> 
signal_deviceAddrChanged
 
boost::signalslib::signal
< void(unsigned)> 
signal_incomingBufferSizeChanged
 
boost::signalslib::signal
< void(unsigned)> 
signal_listenPortChanged
 
boost::signalslib::signal
< void(unsigned)> 
signal_numIncomingBuffersChanged
 
boost::signalslib::signal
< void(unsigned)> 
signal_outgoingBufferSizeChanged
 
boost::signalslib::signal
< void(unsigned)> 
signal_numOutgoingBuffersChanged
 
boost::signalslib::signal
< void(unsigned)> 
signal_packetBufferSizeChanged
 
boost::signalslib::signal
< void(unsigned)> 
signal_sendPortChanged
 
boost::signalslib::signal
< void(DtCigiConnectionInitializer::ConnectionMode)> 
signal_driverModeChanged
 
boost::signalslib::signal
< void(int)> 
signal_tranportTypeChanged
 
boost::signalslib::signal
< void(unsigned int)> 
signal_driverFrequencyChanged
 
boost::signalslib::signal
< void(unsigned int)> 
signal_hostFrequencyChanged
 
boost::signalslib::signal
< void(bool)> 
signal_returnConnectionObjectIdsChanged
 
boost::signalslib::signal< void()> signal_makeAutoConnect
 

Member Enumeration Documentation

Enumerator
Disconnected 
Connected 
Connecting 
Error 
end_ConnectionStatus 

Constructor & Destructor Documentation

virtual makVrv::DtCigiConnectionInterface::~DtCigiConnectionInterface ( )
virtual

Member Function Documentation

virtual void makVrv::DtCigiConnectionInterface::setConnectionStatus ( ConnectionStatus  status)
pure virtual

Set the current status of the connection.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setAutoConnectEnabled ( bool  enabled)
pure virtual

Set whether the auto connect button can be enabled.

Implemented in makVrv::DtCigiConnectionWidget.

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

Set the CIGI version string.

Implemented in makVrv::DtCigiConnectionWidget.

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

Set the CIGI mappings name.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setDeviceIpAddress ( const std::string &  address)
pure virtual

Set the DeviceIpAddress.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setDeviceIpAddresses ( const std::vector< std::string > &  address)
pure virtual

Set the list of available device ip addresses.

Implemented in makVrv::DtCigiConnectionWidget.

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

Set the HostIpAddress.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setIncomingBufferSize ( unsigned  nSize)
pure virtual

set the buffer size for CIGI incoming message queue

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setListenPort ( unsigned  port)
pure virtual

Set the Listen to Host port.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setNumIncomingBuffers ( unsigned  nNum)
pure virtual

set the number of buffers for CIGI incoming message queue

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setNumOutgoingBuffers ( unsigned  nNum)
pure virtual

set the number of buffers for CIGI outgoing message queue

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setOutgoingBufferSize ( unsigned  nSize)
pure virtual

set the buffer size for CIGI outgoing message queue

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setPacketBufferSize ( unsigned  nSize)
pure virtual

Set size of receive packet buffer on network socket.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setSendPort ( unsigned  port)
pure virtual

Set the Send to Host port.

Implemented in makVrv::DtCigiConnectionWidget.

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

Set whether to use synchronous mode.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setTransportType ( int  transportType)
pure virtual

Set the transport type.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setDriverFrequency ( unsigned int  hertz)
pure virtual

Set the frequency of the driver (which is the same as the host frequency for synchronous operation, but may be different for asynchronous mode.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setHostFrequency ( unsigned int  hertz)
pure virtual

Set the host frequency This is only used for asynchronous mode to monitor performance Overload conditions can be detected if it takes longer to process a cigi message than a host frame.

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setEnableHostFrequency ( bool  enable)
pure virtual

Set whether the host frequency widget is enabled (when in async mode)

Implemented in makVrv::DtCigiConnectionWidget.

virtual void makVrv::DtCigiConnectionInterface::setReturnConnectionObjectIds ( bool  returnDisIds)
pure virtual

Set whether CIGI response packet return CIGI Ids or DIS/HLA.

Implemented in makVrv::DtCigiConnectionWidget.

Member Data Documentation

boost::signalslib::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_currentConnectionChanged
boost::signalslib::signal<void ()> makVrv::DtCigiConnectionInterface::signal_connect
boost::signalslib::signal<void ()> makVrv::DtCigiConnectionInterface::signal_disconnect
boost::signalslib::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_cigiVersionChanged
boost::signalslib::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_entityMappingNameChanged
boost::signalslib::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_hostIpChanged
boost::signalslib::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_deviceAddrChanged
boost::signalslib::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_incomingBufferSizeChanged
boost::signalslib::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_listenPortChanged
boost::signalslib::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_numIncomingBuffersChanged
boost::signalslib::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_outgoingBufferSizeChanged
boost::signalslib::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_numOutgoingBuffersChanged
boost::signalslib::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_packetBufferSizeChanged
boost::signalslib::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_sendPortChanged
boost::signalslib::signal<void (DtCigiConnectionInitializer::ConnectionMode)> makVrv::DtCigiConnectionInterface::signal_driverModeChanged
boost::signalslib::signal<void (int)> makVrv::DtCigiConnectionInterface::signal_tranportTypeChanged
boost::signalslib::signal<void (unsigned int)> makVrv::DtCigiConnectionInterface::signal_driverFrequencyChanged
boost::signalslib::signal<void (unsigned int)> makVrv::DtCigiConnectionInterface::signal_hostFrequencyChanged
boost::signalslib::signal<void ( bool )> makVrv::DtCigiConnectionInterface::signal_returnConnectionObjectIdsChanged
boost::signalslib::signal<void ()> makVrv::DtCigiConnectionInterface::signal_makeAutoConnect

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)