Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
QmitkIGTLMessageSourceSelectionWidget Class Reference

This widget allows the user to select a OpenIGTLink message source. More...

#include <QmitkIGTLMessageSourceSelectionWidget.h>

Inheritance diagram for QmitkIGTLMessageSourceSelectionWidget:
Collaboration diagram for QmitkIGTLMessageSourceSelectionWidget:

Signals

void IGTLMessageSourceSelected (mitk::IGTLMessageSource::Pointer source)
 This signal is emitted when a new OpenIGTLink message source is selected. More...
 

Public Member Functions

 QmitkIGTLMessageSourceSelectionWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
 
 ~QmitkIGTLMessageSourceSelectionWidget () override
 
mitk::IGTLMessageSource::Pointer GetSelectedIGTLMessageSource ()
 
mitk::IGTLMessageSource::Pointer AutoSelectFirstIGTLMessageSource ()
 Automatically selects the first available OpenIGTLink message source of the messageSourceSelectionWidget as message source and assigns it to the class member m_CurrentIGTLMessageSource. If there is no OpenIGTLink message source available, a nullptr will be assigned to the m_CurrentIGTLMessageSource. It is important to call this method whenever a new OpenIGTLink client connects to the active OpenIGTLink server. Otherwise, the connection between PLUS and MITK or between Slicer and MITK won't work automatically. More...
 

Static Public Attributes

static const std::string VIEW_ID
 

Protected Slots

void IGTLMessageSourceSelected (us::ServiceReferenceU s)
 

Protected Member Functions

virtual void CreateConnections ()
 Creation of the connections. More...
 
virtual void CreateQtPartControl (QWidget *parent)
 

Protected Attributes

Ui::QmitkIGTLMessageSourceSelectionWidgetControls * m_Controls
 
mitk::IGTLMessageSource::Pointer m_CurrentIGTLMessageSource
 

Detailed Description

This widget allows the user to select a OpenIGTLink message source.

Documentation:

   The widget lists all OpenIGTLink message sources which are available
   as microservice via the module context.

   A signal is emmited whenever the selection changes.

Definition at line 40 of file QmitkIGTLMessageSourceSelectionWidget.h.

Constructor & Destructor Documentation

◆ QmitkIGTLMessageSourceSelectionWidget()

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

◆ ~QmitkIGTLMessageSourceSelectionWidget()

QmitkIGTLMessageSourceSelectionWidget::~QmitkIGTLMessageSourceSelectionWidget ( )
override

Member Function Documentation

◆ AutoSelectFirstIGTLMessageSource()

mitk::IGTLMessageSource::Pointer QmitkIGTLMessageSourceSelectionWidget::AutoSelectFirstIGTLMessageSource ( )

Automatically selects the first available OpenIGTLink message source of the messageSourceSelectionWidget as message source and assigns it to the class member m_CurrentIGTLMessageSource. If there is no OpenIGTLink message source available, a nullptr will be assigned to the m_CurrentIGTLMessageSource. It is important to call this method whenever a new OpenIGTLink client connects to the active OpenIGTLink server. Otherwise, the connection between PLUS and MITK or between Slicer and MITK won't work automatically.

Returns
The pointer to the automatically selected message source. This might be a nullptr, if there is no message source available.

◆ CreateConnections()

virtual void QmitkIGTLMessageSourceSelectionWidget::CreateConnections ( )
protectedvirtual

Creation of the connections.

◆ CreateQtPartControl()

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

◆ GetSelectedIGTLMessageSource()

mitk::IGTLMessageSource::Pointer QmitkIGTLMessageSourceSelectionWidget::GetSelectedIGTLMessageSource ( )
Returns
Returns the currently selected OpenIGTLink message source. Returns null if no source is selected at the moment.

◆ IGTLMessageSourceSelected [1/2]

void QmitkIGTLMessageSourceSelectionWidget::IGTLMessageSourceSelected ( mitk::IGTLMessageSource::Pointer  source)
signal

This signal is emitted when a new OpenIGTLink message source is selected.

Parameters
sourceHolds the new selected OpenIGTLink device source. Is null if the old source is deselected and no new source is selected.

◆ IGTLMessageSourceSelected [2/2]

void QmitkIGTLMessageSourceSelectionWidget::IGTLMessageSourceSelected ( us::ServiceReferenceU  s)
protectedslot

Member Data Documentation

◆ m_Controls

Ui::QmitkIGTLMessageSourceSelectionWidgetControls* QmitkIGTLMessageSourceSelectionWidget::m_Controls
protected

Definition at line 90 of file QmitkIGTLMessageSourceSelectionWidget.h.

◆ m_CurrentIGTLMessageSource

mitk::IGTLMessageSource::Pointer QmitkIGTLMessageSourceSelectionWidget::m_CurrentIGTLMessageSource
protected

Definition at line 92 of file QmitkIGTLMessageSourceSelectionWidget.h.

◆ VIEW_ID

const std::string QmitkIGTLMessageSourceSelectionWidget::VIEW_ID
static

Definition at line 46 of file QmitkIGTLMessageSourceSelectionWidget.h.


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