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

#include <QmitkIGTLStreamingManagementWidget.h>

Inheritance diagram for QmitkIGTLStreamingManagementWidget:

Collaboration 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 More...

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

Public Member Functions
void	LoadSource (mitk::IGTLMessageProvider::Pointer provider)

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

	~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. More...

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

void	SelectSourceAndAdaptGUI ()
	selects the current source and adapts the GUI according to the selection More...

Protected Member Functions
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	OnStartStreamingTimer ()
	Is called when provider requests the start of the streaming timer. More...

void	OnStopStreamingTimer ()
	Is called when provider requests the stop of the streaming timer. More...

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 ()

void	RemoveObserver ()

Protected Attributes
Ui::QmitkIGTLStreamingManagementWidgetControls *	m_Controls

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

mitk::IGTLMessageProvider::Pointer	m_IGTLMsgProvider
	holds the IGTL Message Provider that will send the stream More...

mitk::IGTLMessageSource::Pointer	m_IGTLMsgSource
	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...

QTimer	m_StreamingTimer
	the streaming timer that periodically calls the update method of the provider More...

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 = `nullptr`
	)

Definition at line 39 of file QmitkIGTLStreamingManagementWidget.cpp.

References CreateQtPartControl(), m_Controls, and m_IGTLDevice.

◆ ~QmitkIGTLStreamingManagementWidget()

QmitkIGTLStreamingManagementWidget::~QmitkIGTLStreamingManagementWidget ( )

override

Definition at line 48 of file QmitkIGTLStreamingManagementWidget.cpp.

References RemoveObserver().

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.

References DisableSourceControls(), m_Controls, m_IGTLDevice, m_IGTLMsgProvider, m_IGTLMsgSource, mitkThrow, mitk::IGTLDevice::Ready, mitk::IGTLDevice::Running, and mitk::IGTLDevice::Setup.

Referenced by CreateConnections(), LoadSource(), OnStartStreaming(), OnStopStreaming(), and SourceSelected().

◆ 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

Referenced by CreateConnections(), OnDeviceStateChanged(), OnLostConnection(), OnStartStreamingTimer(), and OnStopStreamingTimer().

◆ CreateConnections()

void QmitkIGTLStreamingManagementWidget::CreateConnections ( )

protectedvirtual

Creation of the connections.

Definition at line 82 of file QmitkIGTLStreamingManagementWidget.cpp.

References AdaptGUIToState(), AdaptGUIToStateSignal(), m_Controls, OnStartStreaming(), OnStopStreaming(), SelectSourceAndAdaptGUI(), SelectSourceAndAdaptGUISignal(), and SourceSelected().

Referenced by CreateQtPartControl().

◆ CreateQtPartControl()

void QmitkIGTLStreamingManagementWidget::CreateQtPartControl ( QWidget * parent )

protectedvirtual

Definition at line 68 of file QmitkIGTLStreamingManagementWidget.cpp.

References CreateConnections(), and m_Controls.

Referenced by QmitkIGTLStreamingManagementWidget().

◆ DisableSourceControls()

void QmitkIGTLStreamingManagementWidget::DisableSourceControls ( )

protected

Definition at line 266 of file QmitkIGTLStreamingManagementWidget.cpp.

References m_Controls.

Referenced by AdaptGUIToState(), LoadSource(), and SourceSelected().

◆ 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

provider This provider will be loaded and might be modified by the user.

Definition at line 189 of file QmitkIGTLStreamingManagementWidget.cpp.

References AdaptGUIToState(), DisableSourceControls(), m_IGTLDevice, m_IGTLMsgProvider, m_IsClient, m_LostConnectionObserverTag, m_NewConnectionObserverTag, m_StartStreamingTimerObserverTag, m_StateModifiedObserverTag, m_StopStreamingTimerObserverTag, m_StreamingTimer, OnDeviceStateChanged(), OnLostConnection(), OnNewConnection(), OnStartStreamingTimer(), OnStopStreamingTimer(), and RemoveObserver().

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

References AdaptGUIToStateSignal().

Referenced by LoadSource().

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

References AdaptGUIToStateSignal().

Referenced by LoadSource().

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

References SelectSourceAndAdaptGUISignal().

Referenced by LoadSource().

◆ OnStartStreaming

void QmitkIGTLStreamingManagementWidget::OnStartStreaming ( )

protectedslot

Definition at line 294 of file QmitkIGTLStreamingManagementWidget.cpp.

References AdaptGUIToState(), m_Controls, m_IGTLMsgProvider, and m_IGTLMsgSource.

Referenced by CreateConnections(), and SelectSourceAndAdaptGUI().

◆ OnStartStreamingTimer()

void QmitkIGTLStreamingManagementWidget::OnStartStreamingTimer ( )

protected

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

Definition at line 330 of file QmitkIGTLStreamingManagementWidget.cpp.

References AdaptGUIToStateSignal(), m_IGTLMsgProvider, m_StreamingTimer, and OnStreamingTimerTimeout().

Referenced by LoadSource().

◆ OnStopStreaming

void QmitkIGTLStreamingManagementWidget::OnStopStreaming ( )

protectedslot

Definition at line 301 of file QmitkIGTLStreamingManagementWidget.cpp.

References AdaptGUIToState(), m_IGTLMsgProvider, and m_IGTLMsgSource.

Referenced by CreateConnections().

◆ OnStopStreamingTimer()

void QmitkIGTLStreamingManagementWidget::OnStopStreamingTimer ( )

protected

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

Definition at line 344 of file QmitkIGTLStreamingManagementWidget.cpp.

References AdaptGUIToStateSignal(), m_IGTLMsgProvider, m_StreamingTimer, and OnStreamingTimerTimeout().

Referenced by LoadSource().

◆ OnStreamingTimerTimeout

void QmitkIGTLStreamingManagementWidget::OnStreamingTimerTimeout ( )

protectedslot

Definition at line 357 of file QmitkIGTLStreamingManagementWidget.cpp.

References m_IGTLMsgProvider, and m_IGTLMsgSource.

Referenced by OnStartStreamingTimer(), and OnStopStreamingTimer().

◆ RemoveObserver()

void QmitkIGTLStreamingManagementWidget::RemoveObserver ( )

protected

Definition at line 53 of file QmitkIGTLStreamingManagementWidget.cpp.

References m_IGTLDevice, m_IGTLMsgProvider, m_LostConnectionObserverTag, m_NewConnectionObserverTag, m_StartStreamingTimerObserverTag, m_StateModifiedObserverTag, and m_StopStreamingTimerObserverTag.

Referenced by LoadSource(), and ~QmitkIGTLStreamingManagementWidget().

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

References m_Controls, OnStartStreaming(), and SourceSelected().

Referenced by CreateConnections().

◆ 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

Referenced by CreateConnections(), and OnNewConnection().

◆ SourceSelected

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

protectedslot

Is called when a new source is selected.

Parameters

source the newly selected source

Definition at line 278 of file QmitkIGTLStreamingManagementWidget.cpp.

References AdaptGUIToState(), DisableSourceControls(), m_Controls, and m_IGTLMsgSource.

Referenced by CreateConnections(), and SelectSourceAndAdaptGUI().

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.

Referenced by AdaptGUIToState(), CreateConnections(), CreateQtPartControl(), DisableSourceControls(), OnStartStreaming(), QmitkIGTLStreamingManagementWidget(), SelectSourceAndAdaptGUI(), and SourceSelected().

◆ m_IGTLDevice

mitk::IGTLDevice::Pointer QmitkIGTLStreamingManagementWidget::m_IGTLDevice

protected

holds the OpenIGTLink device

Definition at line 141 of file QmitkIGTLStreamingManagementWidget.h.

Referenced by AdaptGUIToState(), LoadSource(), QmitkIGTLStreamingManagementWidget(), and RemoveObserver().

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

Referenced by AdaptGUIToState(), LoadSource(), OnStartStreaming(), OnStartStreamingTimer(), OnStopStreaming(), OnStopStreamingTimer(), OnStreamingTimerTimeout(), and RemoveObserver().

◆ m_IGTLMsgSource

mitk::IGTLMessageSource::Pointer QmitkIGTLStreamingManagementWidget::m_IGTLMsgSource

protected

holds the IGTLDeviceSource we are working with.

Definition at line 147 of file QmitkIGTLStreamingManagementWidget.h.

Referenced by AdaptGUIToState(), OnStartStreaming(), OnStopStreaming(), OnStreamingTimerTimeout(), and SourceSelected().

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

Referenced by LoadSource().

◆ m_LostConnectionObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_LostConnectionObserverTag

protected

Definition at line 157 of file QmitkIGTLStreamingManagementWidget.h.

Referenced by LoadSource(), and RemoveObserver().

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

Referenced by LoadSource(), and RemoveObserver().

◆ m_StartStreamingTimerObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_StartStreamingTimerObserverTag

protected

Definition at line 160 of file QmitkIGTLStreamingManagementWidget.h.

Referenced by LoadSource(), and RemoveObserver().

◆ m_StateModifiedObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_StateModifiedObserverTag

protected

Definition at line 159 of file QmitkIGTLStreamingManagementWidget.h.

Referenced by LoadSource(), and RemoveObserver().

◆ m_StopStreamingTimerObserverTag

unsigned long QmitkIGTLStreamingManagementWidget::m_StopStreamingTimerObserverTag

protected

Definition at line 161 of file QmitkIGTLStreamingManagementWidget.h.

Referenced by LoadSource(), and RemoveObserver().

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

Referenced by LoadSource(), OnStartStreamingTimer(), and OnStopStreamingTimer().

◆ VIEW_ID

const std::string QmitkIGTLStreamingManagementWidget::VIEW_ID

static

Definition at line 44 of file QmitkIGTLStreamingManagementWidget.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

◆ QmitkIGTLStreamingManagementWidget()

◆ ~QmitkIGTLStreamingManagementWidget()

Member Function Documentation

◆ AdaptGUIToState

◆ AdaptGUIToStateSignal

◆ CreateConnections()

◆ CreateQtPartControl()

◆ DisableSourceControls()

◆ FillCommandsComboBox()

◆ LoadSource()

◆ OnCommandReceived()

◆ OnDeviceStateChanged()

◆ OnLostConnection()

◆ OnMessageReceived()

◆ OnNewConnection()

◆ OnStartStreaming

◆ OnStartStreamingTimer()

◆ OnStopStreaming

◆ OnStopStreamingTimer()

◆ OnStreamingTimerTimeout

◆ RemoveObserver()

◆ SelectSourceAndAdaptGUI

◆ SelectSourceAndAdaptGUISignal

◆ SourceSelected

Member Data Documentation

◆ m_CommandReceivedObserverTag

◆ m_Controls

◆ m_IGTLDevice

◆ m_IGTLMsgProvider

◆ m_IGTLMsgSource

◆ m_IsClient

◆ m_LostConnectionObserverTag

◆ m_MessageReceivedObserverTag

◆ m_NewConnectionObserverTag

◆ m_StartStreamingTimerObserverTag

◆ m_StateModifiedObserverTag

◆ m_StopStreamingTimerObserverTag

◆ m_StreamingTimer

◆ VIEW_ID