Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
Signals | Public Member Functions | Static Public Attributes | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QmitkIGTLDeviceSetupConnectionWidget Class Reference

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

#include <QmitkIGTLDeviceSetupConnectionWidget.h>

Inheritance diagram for QmitkIGTLDeviceSetupConnectionWidget:
Inheritance graph
[legend]
Collaboration diagram for QmitkIGTLDeviceSetupConnectionWidget:
Collaboration graph
[legend]

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 lost a connection to one of its sockets. 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 
)

◆ ~QmitkIGTLDeviceSetupConnectionWidget()

QmitkIGTLDeviceSetupConnectionWidget::~QmitkIGTLDeviceSetupConnectionWidget ( )
override

Member Function Documentation

◆ AdaptGUIToState

void QmitkIGTLDeviceSetupConnectionWidget::AdaptGUIToState ( )
protectedslot

Adapts the GUI to the state of the device.

◆ 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

◆ CreateConnections()

virtual void QmitkIGTLDeviceSetupConnectionWidget::CreateConnections ( )
protectedvirtual

Creation of the connections.

◆ CreateQtPartControl()

virtual void QmitkIGTLDeviceSetupConnectionWidget::CreateQtPartControl ( QWidget *  parent)
protectedvirtual

◆ DisableSourceControls()

void QmitkIGTLDeviceSetupConnectionWidget::DisableSourceControls ( )
protected

◆ 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
deviceThe widget will be initialized corresponding to the state of this device.

◆ OnBufferIncomingMessages

void QmitkIGTLDeviceSetupConnectionWidget::OnBufferIncomingMessages ( int  state)
protectedslot

Enables/Disables the buffering of incoming messages.

◆ 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

◆ OnCommandReceived()

void QmitkIGTLDeviceSetupConnectionWidget::OnCommandReceived ( )

Is called when the current device received a command.

◆ OnConnect

void QmitkIGTLDeviceSetupConnectionWidget::OnConnect ( )
protectedslot

◆ OnDeviceStateChanged()

void QmitkIGTLDeviceSetupConnectionWidget::OnDeviceStateChanged ( )
protected

Calls AdaptGUIToState()

◆ OnHostnameChanged

void QmitkIGTLDeviceSetupConnectionWidget::OnHostnameChanged ( )
protectedslot

◆ OnLogMessageDetailsCheckBoxClicked

void QmitkIGTLDeviceSetupConnectionWidget::OnLogMessageDetailsCheckBoxClicked ( )
protectedslot

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

◆ OnLostConnection()

void QmitkIGTLDeviceSetupConnectionWidget::OnLostConnection ( )

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

◆ OnMessageReceived()

void QmitkIGTLDeviceSetupConnectionWidget::OnMessageReceived ( )

Is called when the current device received a message.

◆ OnMessageSent()

void QmitkIGTLDeviceSetupConnectionWidget::OnMessageSent ( )

Is called when the current device received a message.

◆ OnNewConnection()

void QmitkIGTLDeviceSetupConnectionWidget::OnNewConnection ( )

Is called when the current device connected to another device.

◆ OnPortChanged

void QmitkIGTLDeviceSetupConnectionWidget::OnPortChanged ( )
protectedslot

◆ OnUpdateFPSLabel

void QmitkIGTLDeviceSetupConnectionWidget::OnUpdateFPSLabel ( )
protectedslot

◆ RemoveObserver()

void QmitkIGTLDeviceSetupConnectionWidget::RemoveObserver ( )
protected

Member Data Documentation

◆ m_CommandReceivedObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_CommandReceivedObserverTag
protected

Definition at line 154 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ m_Controls

Ui::QmitkIGTLDeviceSetupConnectionWidgetControls* QmitkIGTLDeviceSetupConnectionWidget::m_Controls
protected

Definition at line 144 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ m_FPSCalculationTimer

QTimer QmitkIGTLDeviceSetupConnectionWidget::m_FPSCalculationTimer
protected

the timer used to calculate the frames per second

Definition at line 174 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ m_IGTLDevice

mitk::IGTLDevice::Pointer QmitkIGTLDeviceSetupConnectionWidget::m_IGTLDevice
protected

holds the OpenIGTLink device

Definition at line 147 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ 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.

◆ m_LostConnectionObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_LostConnectionObserverTag
protected

Definition at line 155 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ m_MessageReceivedObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_MessageReceivedObserverTag
protected

Definition at line 153 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ m_MessageSentObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_MessageSentObserverTag
protected

Definition at line 152 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ m_NewConnectionObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_NewConnectionObserverTag
protected

Definition at line 156 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ 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.

◆ 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.

◆ m_StateModifiedObserverTag

unsigned long QmitkIGTLDeviceSetupConnectionWidget::m_StateModifiedObserverTag
protected

Definition at line 157 of file QmitkIGTLDeviceSetupConnectionWidget.h.

◆ 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 file: