MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
Signals | Public Member Functions | Static Public Attributes | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QmitkIGTLStreamingManagementWidget Class Reference

An object of this class offers an UI to manage the streaming of message sources. More...

#include <QmitkIGTLStreamingManagementWidget.h>

Inheritance diagram for QmitkIGTLStreamingManagementWidget:

Signals

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

Public Member Functions

void LoadSource (mitk::IGTLMessageProvider::Pointer provider)
 
 QmitkIGTLStreamingManagementWidget (QWidget *parent=nullptr, Qt::WindowFlags f={})
 
 ~QmitkIGTLStreamingManagementWidget () override
 

Static Public Attributes

static const std::string VIEW_ID
 

Protected Slots

void OnStartStreaming ()
 
void OnStopStreaming ()
 
void OnStreamingTimerTimeout ()
 
void SourceSelected (mitk::IGTLMessageSource::Pointer source)
 Is called when a new source is selected.
 
void AdaptGUIToState ()
 Adapts the GUI to the state of the device.
 
void SelectSourceAndAdaptGUI ()
 selects the current source and adapts the GUI according to the selection
 

Protected Member Functions

void OnMessageReceived ()
 Is called when the current device received a message.
 
void OnCommandReceived ()
 Is called when the current device received a command.
 
void OnLostConnection ()
 Is called when the current device lost a connection to one of its sockets.
 
void OnNewConnection ()
 Is called when the current device connected to another device.
 
void OnStartStreamingTimer ()
 Is called when provider requests the start of the streaming timer.
 
void OnStopStreamingTimer ()
 Is called when provider requests the stop of the streaming timer.
 
void OnDeviceStateChanged ()
 Calls AdaptGUIToState()
 
void FillCommandsComboBox ()
 Fills the commands combo box with available commands.
 
virtual void CreateConnections ()
 Creation of the connections.
 
virtual void CreateQtPartControl (QWidget *parent)
 
void DisableSourceControls ()
 
void RemoveObserver ()
 

Protected Attributes

Ui::QmitkIGTLStreamingManagementWidgetControls * m_Controls
 
mitk::IGTLDevice::Pointer m_IGTLDevice
 holds the OpenIGTLink device
 
mitk::IGTLMessageProvider::Pointer m_IGTLMsgProvider
 holds the IGTL Message Provider that will send the stream
 
mitk::IGTLMessageSource::Pointer m_IGTLMsgSource
 holds the IGTLDeviceSource we are working with.
 
bool m_IsClient
 flag to indicate if the IGTL device is a client or a server
 
QTimer m_StreamingTimer
 the streaming timer that periodically calls the update method of the provider
 
unsigned long m_MessageReceivedObserverTag
 
unsigned long m_CommandReceivedObserverTag
 
unsigned long m_LostConnectionObserverTag
 
unsigned long m_NewConnectionObserverTag
 
unsigned long m_StateModifiedObserverTag
 
unsigned long m_StartStreamingTimerObserverTag
 
unsigned long m_StopStreamingTimerObserverTag
 

Detailed Description

An object of this class offers an UI to manage the streaming of message sources.

Documentation:

Definition at line 39 of file QmitkIGTLStreamingManagementWidget.h.

Constructor & Destructor Documentation

◆ QmitkIGTLStreamingManagementWidget()

QmitkIGTLStreamingManagementWidget::QmitkIGTLStreamingManagementWidget ( QWidget * parent = nullptr,
Qt::WindowFlags f = {} )

Definition at line 39 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ ~QmitkIGTLStreamingManagementWidget()

QmitkIGTLStreamingManagementWidget::~QmitkIGTLStreamingManagementWidget ( )
override

Definition at line 48 of file QmitkIGTLStreamingManagementWidget.cpp.

Member Function Documentation

◆ AdaptGUIToState

void QmitkIGTLStreamingManagementWidget::AdaptGUIToState ( )
protectedslot

Adapts the GUI to the state of the device.

Definition at line 101 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ AdaptGUIToStateSignal

void QmitkIGTLStreamingManagementWidget::AdaptGUIToStateSignal ( )
signal

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

◆ CreateConnections()

void QmitkIGTLStreamingManagementWidget::CreateConnections ( )
protectedvirtual

Creation of the connections.

Definition at line 82 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ CreateQtPartControl()

void QmitkIGTLStreamingManagementWidget::CreateQtPartControl ( QWidget * parent)
protectedvirtual

Definition at line 68 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ DisableSourceControls()

void QmitkIGTLStreamingManagementWidget::DisableSourceControls ( )
protected

Definition at line 266 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ FillCommandsComboBox()

void QmitkIGTLStreamingManagementWidget::FillCommandsComboBox ( )
protected

Fills the commands combo box with available commands.

◆ LoadSource()

void QmitkIGTLStreamingManagementWidget::LoadSource ( mitk::IGTLMessageProvider::Pointer provider)

Loads a provider 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
providerThis provider will be loaded and might be modified by the user.

Definition at line 189 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnCommandReceived()

void QmitkIGTLStreamingManagementWidget::OnCommandReceived ( )
protected

Is called when the current device received a command.

Definition at line 311 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnDeviceStateChanged()

void QmitkIGTLStreamingManagementWidget::OnDeviceStateChanged ( )
protected

Calls AdaptGUIToState()

Definition at line 315 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnLostConnection()

void QmitkIGTLStreamingManagementWidget::OnLostConnection ( )
protected

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

Definition at line 320 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnMessageReceived()

void QmitkIGTLStreamingManagementWidget::OnMessageReceived ( )
protected

Is called when the current device received a message.

Definition at line 307 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnNewConnection()

void QmitkIGTLStreamingManagementWidget::OnNewConnection ( )
protected

Is called when the current device connected to another device.

Definition at line 325 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnStartStreaming

void QmitkIGTLStreamingManagementWidget::OnStartStreaming ( )
protectedslot

Definition at line 294 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnStartStreamingTimer()

void QmitkIGTLStreamingManagementWidget::OnStartStreamingTimer ( )
protected

Is called when provider requests the start of the streaming timer.

Definition at line 330 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnStopStreaming

void QmitkIGTLStreamingManagementWidget::OnStopStreaming ( )
protectedslot

Definition at line 301 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnStopStreamingTimer()

void QmitkIGTLStreamingManagementWidget::OnStopStreamingTimer ( )
protected

Is called when provider requests the stop of the streaming timer.

Definition at line 344 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ OnStreamingTimerTimeout

void QmitkIGTLStreamingManagementWidget::OnStreamingTimerTimeout ( )
protectedslot

Definition at line 357 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ RemoveObserver()

void QmitkIGTLStreamingManagementWidget::RemoveObserver ( )
protected

Definition at line 53 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ SelectSourceAndAdaptGUI

void QmitkIGTLStreamingManagementWidget::SelectSourceAndAdaptGUI ( )
protectedslot

selects the current source and adapts the GUI according to the selection

Definition at line 365 of file QmitkIGTLStreamingManagementWidget.cpp.

◆ SelectSourceAndAdaptGUISignal

void QmitkIGTLStreamingManagementWidget::SelectSourceAndAdaptGUISignal ( )
signal

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

◆ SourceSelected

void QmitkIGTLStreamingManagementWidget::SourceSelected ( mitk::IGTLMessageSource::Pointer source)
protectedslot

Is called when a new source is selected.

Parameters
sourcethe newly selected source

Definition at line 278 of file QmitkIGTLStreamingManagementWidget.cpp.

Member Data Documentation

◆ m_CommandReceivedObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_CommandReceivedObserverTag
protected

Definition at line 156 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_Controls

Ui::QmitkIGTLStreamingManagementWidgetControls* QmitkIGTLStreamingManagementWidget::m_Controls
protected

Definition at line 138 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_IGTLDevice

mitk::IGTLDevice::Pointer QmitkIGTLStreamingManagementWidget::m_IGTLDevice
protected

holds the OpenIGTLink device

Definition at line 141 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_IGTLMsgProvider

mitk::IGTLMessageProvider::Pointer QmitkIGTLStreamingManagementWidget::m_IGTLMsgProvider
protected

holds the IGTL Message Provider that will send the stream

Definition at line 144 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_IGTLMsgSource

mitk::IGTLMessageSource::Pointer QmitkIGTLStreamingManagementWidget::m_IGTLMsgSource
protected

holds the IGTLDeviceSource we are working with.

Definition at line 147 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_IsClient

bool QmitkIGTLStreamingManagementWidget::m_IsClient
protected

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

Definition at line 150 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_LostConnectionObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_LostConnectionObserverTag
protected

Definition at line 157 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_MessageReceivedObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_MessageReceivedObserverTag
protected

Definition at line 155 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_NewConnectionObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_NewConnectionObserverTag
protected

Definition at line 158 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_StartStreamingTimerObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_StartStreamingTimerObserverTag
protected

Definition at line 160 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_StateModifiedObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_StateModifiedObserverTag
protected

Definition at line 159 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_StopStreamingTimerObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_StopStreamingTimerObserverTag
protected

Definition at line 161 of file QmitkIGTLStreamingManagementWidget.h.

◆ m_StreamingTimer

QTimer QmitkIGTLStreamingManagementWidget::m_StreamingTimer
protected

the streaming timer that periodically calls the update method of the provider

Definition at line 153 of file QmitkIGTLStreamingManagementWidget.h.

◆ VIEW_ID

const std::string QmitkIGTLStreamingManagementWidget::VIEW_ID
static
Initial value:
=
"org.mitk.views.igtldevicesourcemanagementwidget"

Definition at line 44 of file QmitkIGTLStreamingManagementWidget.h.

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