makVrv::DtCigiConnectionInterface Class Reference

Abstract interface for a CIGI connection widget. More...

Inheritance diagram for makVrv::DtCigiConnectionInterface:

List of all members.

Public Types
enum	ConnectionStatus {   Disconnected, Connected, Connecting, Error,   end_ConnectionStatus }
Public Member Functions
virtual	~DtCigiConnectionInterface ()
virtual void	setConnectionStatus (ConnectionStatus status)=0
	Set the current status of the connection.
virtual void	setAutoConnectEnabled (bool enabled)=0
	Set whether the auto connect button can be enabled.
virtual void	setCigiVersion (const std::string &version)=0
	Set the CIGI version string.
virtual void	setCigiMappingsName (const std::string &name)=0
	Set the CIGI mappings name.
virtual void	setDeviceIpAddress (const std::string &address)=0
	Set the DeviceIpAddress.
virtual void	setDeviceIpAddresses (const std::vector< std::string > &address)=0
	Set the list of available device ip addresses.
virtual void	setHostIpAddress (const std::string &address)=0
	Set the HostIpAddress.
virtual void	setIncomingBufferSize (unsigned nSize)=0
	set the buffer size for CIGI incoming message queue
virtual void	setListenPort (unsigned port)=0
	Set the Listen to Host port.
virtual void	setNumIncomingBuffers (unsigned nNum)=0
	set the number of buffers for CIGI incoming message queue
virtual void	setNumOutgoingBuffers (unsigned nNum)=0
	set the number of buffers for CIGI outgoing message queue
virtual void	setOutgoingBufferSize (unsigned nSize)=0
	set the buffer size for CIGI outgoing message queue
virtual void	setPacketBufferSize (unsigned nSize)=0
	Set size of receive packet buffer on network socket.
virtual void	setSendPort (unsigned port)=0
	Set the Send to Host port.
virtual void	setDriverMode (const std::string &mode)=0
	Set whether to use synchronous mode.
virtual void	setTransportType (int transportType)=0
	Set the transport type.
virtual void	setDriverFrequency (unsigned int hertz)=0
	Set the frequency.
Public Attributes
boost::signal< void(const std::string &)>	signal_currentConnectionChanged
boost::signal< void()>	signal_connect
boost::signal< void()>	signal_disconnect
boost::signal< void(const std::string &)>	signal_cigiVersionChanged
boost::signal< void(const std::string &)>	signal_entityMappingNameChanged
boost::signal< void(const std::string &)>	signal_hostIpChanged
boost::signal< void(const std::string &)>	signal_deviceAddrChanged
boost::signal< void(unsigned)>	signal_incomingBufferSizeChanged
boost::signal< void(unsigned)>	signal_listenPortChanged
boost::signal< void(unsigned)>	signal_numIncomingBuffersChanged
boost::signal< void(unsigned)>	signal_outgoingBufferSizeChanged
boost::signal< void(unsigned)>	signal_numOutgoingBuffersChanged
boost::signal< void(unsigned)>	signal_packetBufferSizeChanged
boost::signal< void(unsigned)>	signal_sendPortChanged
boost::signal< void(const std::string &)>	signal_driverModeChanged
boost::signal< void(int)>	signal_tranportTypeChanged
boost::signal< void(unsigned int)>	signal_driverFrequencyChanged
boost::signal< void()>	signal_makeAutoConnect

---

Detailed Description

Abstract interface for a CIGI connection widget.

---

Member Enumeration Documentation

enum makVrv::DtCigiConnectionInterface::ConnectionStatus

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

(

const std::string &

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.

Implemented in makVrv::DtCigiConnectionWidget.

---

Member Data Documentation

boost::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_currentConnectionChanged

boost::signal<void ()> makVrv::DtCigiConnectionInterface::signal_connect

boost::signal<void ()> makVrv::DtCigiConnectionInterface::signal_disconnect

boost::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_cigiVersionChanged

boost::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_entityMappingNameChanged

boost::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_hostIpChanged

boost::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_deviceAddrChanged

boost::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_incomingBufferSizeChanged

boost::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_listenPortChanged

boost::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_numIncomingBuffersChanged

boost::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_outgoingBufferSizeChanged

boost::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_numOutgoingBuffersChanged

boost::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_packetBufferSizeChanged

boost::signal<void (unsigned)> makVrv::DtCigiConnectionInterface::signal_sendPortChanged

boost::signal<void (const std::string&)> makVrv::DtCigiConnectionInterface::signal_driverModeChanged

boost::signal<void (int)> makVrv::DtCigiConnectionInterface::signal_tranportTypeChanged

boost::signal<void (unsigned int)> makVrv::DtCigiConnectionInterface::signal_driverFrequencyChanged

boost::signal<void ()> makVrv::DtCigiConnectionInterface::signal_makeAutoConnect

---

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

• include/vrvCigiQt/DtCigiConnectionInterface.h