An object of this class offers an UI to setup the connection of an OpenIGTLink device. More...

#include <QmitkIGTLDeviceSetupConnectionWidget.h>

Inheritance diagram for QmitkIGTLDeviceSetupConnectionWidget:

Collaboration diagram for QmitkIGTLDeviceSetupConnectionWidget:

Signals
void	AdaptGUIToStateSignal ()
	used for thread seperation, the worker thread must not call AdaptGUIToState directly. QT signals are thread safe and seperate the threads More...

Public Member Functions
void	Initialize (mitk::IGTLDevice::Pointer device)
	Initializes the widget with the given device. More...

	QmitkIGTLDeviceSetupConnectionWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)

	~QmitkIGTLDeviceSetupConnectionWidget () override

void	OnLostConnection ()
	Is called when the current device received a message. More...

void	OnNewConnection ()
	Is called when the current device connected to another device. More...

void	OnMessageReceived ()
	Is called when the current device received a message. More...

void	OnMessageSent ()
	Is called when the current device received a message. More...

void	OnCommandReceived ()
	Is called when the current device received a command. More...

Static Public Attributes
static const std::string	VIEW_ID

Protected Slots
void	OnConnect ()

void	OnPortChanged ()

void	OnHostnameChanged ()

void	OnUpdateFPSLabel ()

void	OnLogMessageDetailsCheckBoxClicked ()
	Enables/Disables the detailed logging of incoming/outgoing messages. More...

void	OnBufferIncomingMessages (int state)
	Enables/Disables the buffering of incoming messages. More...

void	OnBufferOutgoingMessages (int state)
	Enables/Disables the buffering of outgoing messages. More...

void	AdaptGUIToState ()
	Adapts the GUI to the state of the device. More...

Protected Member Functions
void	OnDeviceStateChanged ()
	Calls AdaptGUIToState() More...

virtual void	CreateConnections ()
	Creation of the connections. More...

virtual void	CreateQtPartControl (QWidget *parent)

void	DisableSourceControls ()

void	RemoveObserver ()

Protected Attributes
Ui::QmitkIGTLDeviceSetupConnectionWidgetControls *	m_Controls

mitk::IGTLDevice::Pointer	m_IGTLDevice
	holds the OpenIGTLink device More...

bool	m_IsClient
	flag to indicate if the IGTL device is a client or a server More...

unsigned long	m_MessageSentObserverTag

unsigned long	m_MessageReceivedObserverTag

unsigned long	m_CommandReceivedObserverTag

unsigned long	m_LostConnectionObserverTag

unsigned long	m_NewConnectionObserverTag

unsigned long	m_StateModifiedObserverTag

unsigned int	m_NumReceivedFramesSinceLastUpdate
	the number of received frames (messages) since the last fps calculation update More...

unsigned int	m_NumSentFramesSinceLastUpdate
	the number of sent frames (messages) since the last fps calculation update More...

QTimer	m_FPSCalculationTimer
	the timer used to calculate the frames per second More...

Detailed Description

An object of this class offers an UI to setup the connection of an OpenIGTLink device.

Documentation:

Definition at line 39 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Constructor & Destructor Documentation

◆ QmitkIGTLDeviceSetupConnectionWidget()

QmitkIGTLDeviceSetupConnectionWidget::QmitkIGTLDeviceSetupConnectionWidget	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	f = `nullptr`
	)

Definition at line 41 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References CreateQtPartControl(), m_Controls, m_IGTLDevice, m_NumReceivedFramesSinceLastUpdate, and m_NumSentFramesSinceLastUpdate.

◆ ~QmitkIGTLDeviceSetupConnectionWidget()

QmitkIGTLDeviceSetupConnectionWidget::~QmitkIGTLDeviceSetupConnectionWidget ( )

override

Definition at line 52 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References RemoveObserver().

Member Function Documentation

◆ AdaptGUIToState

void QmitkIGTLDeviceSetupConnectionWidget::AdaptGUIToState ( )

protectedslot

Adapts the GUI to the state of the device.

Definition at line 125 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_Controls, m_IGTLDevice, m_IsClient, mitkThrow, mitk::IGTLDevice::Ready, mitk::IGTLDevice::Running, and mitk::IGTLDevice::Setup.

Referenced by CreateConnections(), Initialize(), and OnConnect().

◆ AdaptGUIToStateSignal

void QmitkIGTLDeviceSetupConnectionWidget::AdaptGUIToStateSignal ( )

signal

used for thread seperation, the worker thread must not call AdaptGUIToState directly. QT signals are thread safe and seperate the threads

Referenced by CreateConnections(), OnDeviceStateChanged(), OnLostConnection(), and OnNewConnection().

◆ CreateConnections()

void QmitkIGTLDeviceSetupConnectionWidget::CreateConnections ( )

protectedvirtual

Creation of the connections.

Definition at line 95 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References AdaptGUIToState(), AdaptGUIToStateSignal(), m_Controls, m_FPSCalculationTimer, OnBufferIncomingMessages(), OnBufferOutgoingMessages(), OnConnect(), OnHostnameChanged(), OnLogMessageDetailsCheckBoxClicked(), OnPortChanged(), and OnUpdateFPSLabel().

Referenced by CreateQtPartControl().

◆ CreateQtPartControl()

void QmitkIGTLDeviceSetupConnectionWidget::CreateQtPartControl ( QWidget * parent )

protectedvirtual

Definition at line 70 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References CreateConnections(), m_Controls, and m_FPSCalculationTimer.

Referenced by QmitkIGTLDeviceSetupConnectionWidget().

◆ DisableSourceControls()

void QmitkIGTLDeviceSetupConnectionWidget::DisableSourceControls ( )

protected

Definition at line 286 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_Controls, and m_IGTLDevice.

Referenced by Initialize().

◆ Initialize()

void QmitkIGTLDeviceSetupConnectionWidget::Initialize ( mitk::IGTLDevice::Pointer device )

Initializes the widget with the given device.

The old device is dropped, so be careful, if the source is not saved somewhere else it might be lost. You might want to ask the user if he wants to save the changes before calling this method.

Parameters

device The widget will be initialized corresponding to the state of this device.

Definition at line 215 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References AdaptGUIToState(), DisableSourceControls(), m_CommandReceivedObserverTag, m_Controls, m_IGTLDevice, m_IsClient, m_LostConnectionObserverTag, m_MessageReceivedObserverTag, m_MessageSentObserverTag, m_NewConnectionObserverTag, m_StateModifiedObserverTag, OnBufferIncomingMessages(), OnBufferOutgoingMessages(), OnCommandReceived(), OnDeviceStateChanged(), OnLostConnection(), OnMessageReceived(), OnMessageSent(), OnNewConnection(), and RemoveObserver().

◆ OnBufferIncomingMessages

void QmitkIGTLDeviceSetupConnectionWidget::OnBufferIncomingMessages ( int state )

protectedslot

Enables/Disables the buffering of incoming messages.

Definition at line 397 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_IGTLDevice.

Referenced by CreateConnections(), and Initialize().

◆ OnBufferOutgoingMessages

void QmitkIGTLDeviceSetupConnectionWidget::OnBufferOutgoingMessages ( int state )

protectedslot

Enables/Disables the buffering of outgoing messages.

This can be necessary when the data is faster produced then sent

Definition at line 406 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_IGTLDevice.

Referenced by CreateConnections(), and Initialize().

◆ OnCommandReceived()

void QmitkIGTLDeviceSetupConnectionWidget::OnCommandReceived ( )

Is called when the current device received a command.

Definition at line 389 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_Controls, and MITK_INFO.

Referenced by Initialize().

◆ OnConnect

void QmitkIGTLDeviceSetupConnectionWidget::OnConnect ( )

protectedslot

Definition at line 304 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References AdaptGUIToState(), m_Controls, m_IGTLDevice, m_IsClient, MITK_ERROR, MITK_INFO, mitkThrow, mitk::IGTLDevice::Ready, mitk::IGTLDevice::Running, and mitk::IGTLDevice::Setup.

Referenced by CreateConnections().

◆ OnDeviceStateChanged()

void QmitkIGTLDeviceSetupConnectionWidget::OnDeviceStateChanged ( )

protected

Calls AdaptGUIToState()

Definition at line 120 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References AdaptGUIToStateSignal().

Referenced by Initialize().

◆ OnHostnameChanged

void QmitkIGTLDeviceSetupConnectionWidget::OnHostnameChanged ( )

protectedslot

Definition at line 357 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

Referenced by CreateConnections().

◆ OnLogMessageDetailsCheckBoxClicked

void QmitkIGTLDeviceSetupConnectionWidget::OnLogMessageDetailsCheckBoxClicked ( )

protectedslot

Enables/Disables the detailed logging of incoming/outgoing messages.

Definition at line 425 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_Controls, m_IGTLDevice, and MITK_WARN.

Referenced by CreateConnections().

◆ OnLostConnection()

void QmitkIGTLDeviceSetupConnectionWidget::OnLostConnection ( )

Is called when the current device received a message.

Is called when the current device received a command Is called when the current device lost a connection to one of its sockets

Definition at line 361 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References AdaptGUIToStateSignal().

Referenced by Initialize().

◆ OnMessageReceived()

void QmitkIGTLDeviceSetupConnectionWidget::OnMessageReceived ( )

Is called when the current device received a message.

Definition at line 371 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_Controls, m_NumReceivedFramesSinceLastUpdate, and MITK_INFO.

Referenced by Initialize().

◆ OnMessageSent()

void QmitkIGTLDeviceSetupConnectionWidget::OnMessageSent ( )

Is called when the current device received a message.

Definition at line 380 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_Controls, m_NumSentFramesSinceLastUpdate, and MITK_INFO.

Referenced by Initialize().

◆ OnNewConnection()

void QmitkIGTLDeviceSetupConnectionWidget::OnNewConnection ( )

Is called when the current device connected to another device.

Definition at line 366 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References AdaptGUIToStateSignal().

Referenced by Initialize().

◆ OnPortChanged

void QmitkIGTLDeviceSetupConnectionWidget::OnPortChanged ( )

protectedslot

Definition at line 353 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

Referenced by CreateConnections().

◆ OnUpdateFPSLabel

void QmitkIGTLDeviceSetupConnectionWidget::OnUpdateFPSLabel ( )

protectedslot

Definition at line 415 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_Controls, m_NumReceivedFramesSinceLastUpdate, and m_NumSentFramesSinceLastUpdate.

Referenced by CreateConnections().

◆ RemoveObserver()

void QmitkIGTLDeviceSetupConnectionWidget::RemoveObserver ( )

protected

Definition at line 57 of file QmitkIGTLDeviceSetupConnectionWidget.cpp.

References m_CommandReceivedObserverTag, m_IGTLDevice, m_LostConnectionObserverTag, m_MessageReceivedObserverTag, m_MessageSentObserverTag, m_NewConnectionObserverTag, and m_StateModifiedObserverTag.

Referenced by Initialize(), and ~QmitkIGTLDeviceSetupConnectionWidget().

Member Data Documentation

◆ m_CommandReceivedObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_CommandReceivedObserverTag

protected

Definition at line 154 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by Initialize(), and RemoveObserver().

◆ m_Controls

Ui::QmitkIGTLDeviceSetupConnectionWidgetControls* QmitkIGTLDeviceSetupConnectionWidget::m_Controls

protected

Definition at line 144 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by AdaptGUIToState(), CreateConnections(), CreateQtPartControl(), DisableSourceControls(), Initialize(), OnCommandReceived(), OnConnect(), OnLogMessageDetailsCheckBoxClicked(), OnMessageReceived(), OnMessageSent(), OnUpdateFPSLabel(), and QmitkIGTLDeviceSetupConnectionWidget().

◆ m_FPSCalculationTimer

QTimer QmitkIGTLDeviceSetupConnectionWidget::m_FPSCalculationTimer

protected

the timer used to calculate the frames per second

Definition at line 174 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by CreateConnections(), and CreateQtPartControl().

◆ m_IGTLDevice

mitk::IGTLDevice::Pointer QmitkIGTLDeviceSetupConnectionWidget::m_IGTLDevice

protected

holds the OpenIGTLink device

Definition at line 147 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by AdaptGUIToState(), DisableSourceControls(), Initialize(), OnBufferIncomingMessages(), OnBufferOutgoingMessages(), OnConnect(), OnLogMessageDetailsCheckBoxClicked(), QmitkIGTLDeviceSetupConnectionWidget(), and RemoveObserver().

◆ m_IsClient

bool QmitkIGTLDeviceSetupConnectionWidget::m_IsClient

protected

flag to indicate if the IGTL device is a client or a server

Definition at line 150 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by AdaptGUIToState(), Initialize(), and OnConnect().

◆ m_LostConnectionObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_LostConnectionObserverTag

protected

Definition at line 155 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by Initialize(), and RemoveObserver().

◆ m_MessageReceivedObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_MessageReceivedObserverTag

protected

Definition at line 153 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by Initialize(), and RemoveObserver().

◆ m_MessageSentObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_MessageSentObserverTag

protected

Definition at line 152 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by Initialize(), and RemoveObserver().

◆ m_NewConnectionObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_NewConnectionObserverTag

protected

Definition at line 156 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by Initialize(), and RemoveObserver().

◆ m_NumReceivedFramesSinceLastUpdate

unsigned int QmitkIGTLDeviceSetupConnectionWidget::m_NumReceivedFramesSinceLastUpdate

protected

the number of received frames (messages) since the last fps calculation update

This counter is incremented every time a message is received. When the timer m_FPSCalculationTimer is fired it is reset to 0 and the number is used to calculate the FPS

Definition at line 164 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by OnMessageReceived(), OnUpdateFPSLabel(), and QmitkIGTLDeviceSetupConnectionWidget().

◆ m_NumSentFramesSinceLastUpdate

unsigned int QmitkIGTLDeviceSetupConnectionWidget::m_NumSentFramesSinceLastUpdate

protected

the number of sent frames (messages) since the last fps calculation update

This counter is incremented every time a message is sent. When the timer m_FPSCalculationTimer is fired it is reset to 0 and the number is used to calculate the FPS

Definition at line 171 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by OnMessageSent(), OnUpdateFPSLabel(), and QmitkIGTLDeviceSetupConnectionWidget().

◆ m_StateModifiedObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_StateModifiedObserverTag

protected

Definition at line 157 of file QmitkIGTLDeviceSetupConnectionWidget.h.

Referenced by Initialize(), and RemoveObserver().

◆ VIEW_ID

const std::string QmitkIGTLDeviceSetupConnectionWidget::VIEW_ID

static

Definition at line 44 of file QmitkIGTLDeviceSetupConnectionWidget.h.

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

Signals

Public Member Functions

Static Public Attributes

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QmitkIGTLDeviceSetupConnectionWidget()

◆ ~QmitkIGTLDeviceSetupConnectionWidget()

Member Function Documentation

◆ AdaptGUIToState

◆ AdaptGUIToStateSignal

◆ CreateConnections()

◆ CreateQtPartControl()

◆ DisableSourceControls()

◆ Initialize()

◆ OnBufferIncomingMessages

◆ OnBufferOutgoingMessages

◆ OnCommandReceived()

◆ OnConnect

◆ OnDeviceStateChanged()

◆ OnHostnameChanged

◆ OnLogMessageDetailsCheckBoxClicked

◆ OnLostConnection()

◆ OnMessageReceived()

◆ OnMessageSent()

◆ OnNewConnection()

◆ OnPortChanged

◆ OnUpdateFPSLabel

◆ RemoveObserver()

Member Data Documentation

◆ m_CommandReceivedObserverTag

◆ m_Controls

◆ m_FPSCalculationTimer

◆ m_IGTLDevice

◆ m_IsClient

◆ m_LostConnectionObserverTag

◆ m_MessageReceivedObserverTag

◆ m_MessageSentObserverTag

◆ m_NewConnectionObserverTag

◆ m_NumReceivedFramesSinceLastUpdate

◆ m_NumSentFramesSinceLastUpdate

◆ m_StateModifiedObserverTag

◆ VIEW_ID