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
QmitkIGTLDeviceSourceManagementWidget Class Reference

An object of this class offers an UI to manage OpenIGTLink Device Sources and OpenIGTLink Devices. More...

#include <QmitkIGTLDeviceSourceManagementWidget.h>

Inheritance diagram for QmitkIGTLDeviceSourceManagementWidget:
Inheritance graph
[legend]
Collaboration diagram for QmitkIGTLDeviceSourceManagementWidget:
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 LoadSource (mitk::IGTLDeviceSource::Pointer sourceToLoad)
 
 QmitkIGTLDeviceSourceManagementWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
 
 ~QmitkIGTLDeviceSourceManagementWidget () override
 

Static Public Attributes

static const std::string VIEW_ID
 

Protected Slots

void OnSendMessage ()
 
void OnMessageReceived ()
 Is called when the current device received a message. More...
 
void OnCommandReceived ()
 Is called when the current device received a command. More...
 
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 AdaptGUIToState ()
 Adapts the GUI to the state of the device. More...
 

Protected Member Functions

void OnDeviceStateChanged ()
 Calls AdaptGUIToState() More...
 
void FillCommandsComboBox ()
 Fills the commands combo box with available commands. More...
 
virtual void CreateConnections ()
 Creation of the connections. More...
 
virtual void CreateQtPartControl (QWidget *parent)
 
void DisableSourceControls ()
 

Protected Attributes

Ui::QmitkIGTLDeviceSourceManagementWidgetControls * m_Controls
 
mitk::IGTLDevice::Pointer m_IGTLDevice
 holds the OpenIGTLink device More...
 
mitk::IGTLDeviceSource::Pointer m_IGTLDeviceSource
 holds the IGTLDeviceSource we are working with. More...
 
bool m_IsClient
 flag to indicate if the IGTL device is a client or a server More...
 
unsigned long m_MessageReceivedObserverTag
 
unsigned long m_CommandReceivedObserverTag
 
unsigned long m_LostConnectionObserverTag
 
unsigned long m_NewConnectionObserverTag
 
unsigned long m_StateModifiedObserverTag
 

Detailed Description

An object of this class offers an UI to manage OpenIGTLink Device Sources and OpenIGTLink Devices.

Documentation:

Definition at line 39 of file QmitkIGTLDeviceSourceManagementWidget.h.

Constructor & Destructor Documentation

◆ QmitkIGTLDeviceSourceManagementWidget()

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

◆ ~QmitkIGTLDeviceSourceManagementWidget()

QmitkIGTLDeviceSourceManagementWidget::~QmitkIGTLDeviceSourceManagementWidget ( )
override

Member Function Documentation

◆ AdaptGUIToState

void QmitkIGTLDeviceSourceManagementWidget::AdaptGUIToState ( )
protectedslot

Adapts the GUI to the state of the device.

◆ AdaptGUIToStateSignal

void QmitkIGTLDeviceSourceManagementWidget::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 QmitkIGTLDeviceSourceManagementWidget::CreateConnections ( )
protectedvirtual

Creation of the connections.

◆ CreateQtPartControl()

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

◆ DisableSourceControls()

void QmitkIGTLDeviceSourceManagementWidget::DisableSourceControls ( )
protected

◆ FillCommandsComboBox()

void QmitkIGTLDeviceSourceManagementWidget::FillCommandsComboBox ( )
protected

Fills the commands combo box with available commands.

◆ LoadSource()

void QmitkIGTLDeviceSourceManagementWidget::LoadSource ( mitk::IGTLDeviceSource::Pointer  sourceToLoad)

Loads a source to the widget. The old source 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
sourceToLoadThis source will be loaded and might be modified by the user.

◆ OnCommandReceived

void QmitkIGTLDeviceSourceManagementWidget::OnCommandReceived ( )
protectedslot

Is called when the current device received a command.

◆ OnDeviceStateChanged()

void QmitkIGTLDeviceSourceManagementWidget::OnDeviceStateChanged ( )
protected

Calls AdaptGUIToState()

◆ OnLostConnection

void QmitkIGTLDeviceSourceManagementWidget::OnLostConnection ( )
protectedslot

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

◆ OnMessageReceived

void QmitkIGTLDeviceSourceManagementWidget::OnMessageReceived ( )
protectedslot

Is called when the current device received a message.

◆ OnNewConnection

void QmitkIGTLDeviceSourceManagementWidget::OnNewConnection ( )
protectedslot

Is called when the current device connected to another device.

◆ OnSendMessage

void QmitkIGTLDeviceSourceManagementWidget::OnSendMessage ( )
protectedslot

Member Data Documentation

◆ m_CommandReceivedObserverTag

unsigned long QmitkIGTLDeviceSourceManagementWidget::m_CommandReceivedObserverTag
protected

Definition at line 120 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_Controls

Ui::QmitkIGTLDeviceSourceManagementWidgetControls* QmitkIGTLDeviceSourceManagementWidget::m_Controls
protected

Definition at line 108 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_IGTLDevice

mitk::IGTLDevice::Pointer QmitkIGTLDeviceSourceManagementWidget::m_IGTLDevice
protected

holds the OpenIGTLink device

Definition at line 111 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_IGTLDeviceSource

mitk::IGTLDeviceSource::Pointer QmitkIGTLDeviceSourceManagementWidget::m_IGTLDeviceSource
protected

holds the IGTLDeviceSource we are working with.

Definition at line 114 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_IsClient

bool QmitkIGTLDeviceSourceManagementWidget::m_IsClient
protected

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

Definition at line 117 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_LostConnectionObserverTag

unsigned long QmitkIGTLDeviceSourceManagementWidget::m_LostConnectionObserverTag
protected

Definition at line 121 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_MessageReceivedObserverTag

unsigned long QmitkIGTLDeviceSourceManagementWidget::m_MessageReceivedObserverTag
protected

Definition at line 119 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_NewConnectionObserverTag

unsigned long QmitkIGTLDeviceSourceManagementWidget::m_NewConnectionObserverTag
protected

Definition at line 122 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ m_StateModifiedObserverTag

unsigned long QmitkIGTLDeviceSourceManagementWidget::m_StateModifiedObserverTag
protected

Definition at line 123 of file QmitkIGTLDeviceSourceManagementWidget.h.

◆ VIEW_ID

const std::string QmitkIGTLDeviceSourceManagementWidget::VIEW_ID
static

Definition at line 44 of file QmitkIGTLDeviceSourceManagementWidget.h.

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