Implementation of a configuration widget for NDI Aurora Devices. More...

#include <QmitkNDIAuroraWidget.h>

Inheritance diagram for QmitkNDIAuroraWidget:

Public Member Functions
	QmitkNDIAuroraWidget (QWidget *parent=nullptr, Qt::WindowFlags f={})

	~QmitkNDIAuroraWidget () override

void	Initialize () override
	Subclass must implement this method to return a pointer to a copy of the object. Please don't forget to call InitializeSuperclassWidget(), CreateQtPartControl and optionally CreateConnections during this function.

Public Member Functions inherited from QmitkNDIAbstractDeviceWidget
	QmitkNDIAbstractDeviceWidget (QWidget *parent=nullptr, Qt::WindowFlags f={})

	~QmitkNDIAbstractDeviceWidget () override

Public Member Functions inherited from QmitkAbstractTrackingDeviceWidget
	QmitkAbstractTrackingDeviceWidget (QWidget *parent=nullptr, Qt::WindowFlags f={})

	~QmitkAbstractTrackingDeviceWidget () override

QmitkAbstractTrackingDeviceWidget *	CloneForQt (QWidget *parent=nullptr) const
	Return pointer to copy of the object. Internally use of QmitkUSAbstractCustomWidget::Clone() with additionaly setting an internal flag that the object was really cloned.

bool	IsInitialized () const

virtual bool	IsDeviceInstalled ()
	Optional method to investigate if drivers etc for your device are installed. The default value is "true" as most devices don't need this information. Others however migth crash, and for these you might implement this function (see QmitkMicronTrackerWidget)

virtual void	OnConnected (bool)
	This function is called, when in the TrackingToolboxView "Connect" was clicked and the device is successful connected. Can e.g. be used to activate options of a tracking device only when it is connected.

virtual void	OnDisconnected (bool)
	This function is called, when in the TrackingToolboxView "Disconnect" was clicked and the device is successful disconnected. Can e.g. be used to activate/disactivate options of a tracking device.

virtual void	OnStartTracking (bool)
	This function is called, when in the TrackingToolboxView "Start Tracking" was clicked and the device successfully started tracking. Can e.g. be used to activate options of a tracking device only when tracking is started.

virtual void	OnStopTracking (bool)
	This function is called, when in the TrackingToolboxView "Stop Tracking" was clicked and the device successful stopped tracking. Can e.g. be used to activate/disactivate options when device is not tracking.

virtual void	OnToolStorageChanged ()
	This function is called, when anything in the ToolStorage changed, e.g. AddTool or EditTool. ServiceListener is connected in the QmitkMITKIGTTrackingToolboxView.

Static Public Attributes
static const std::string	VIEW_ID = "org.mitk.views.NDIAuroraWidget"

Static Public Attributes inherited from QmitkNDIAbstractDeviceWidget
static const std::string	VIEW_ID = "org.mitk.views.NDIAbstractDeviceWidget"

Static Public Attributes inherited from QmitkAbstractTrackingDeviceWidget
static const std::string	VIEW_ID

Protected Member Functions
void	ResetOutput () override
	Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget)

void	AddOutput (std::string s) override
	Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget)

mitk::TrackingDevice::Pointer	GetTrackingDevice () override

void	StoreUISettings () override
	Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget)

void	LoadUISettings () override
	Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget)

void	SetPortValueToGUI (int portValue) override

void	SetPortTypeToGUI (int portType) override

QmitkNDIAuroraWidget *	Clone (QWidget *parent) const override
	Subclass must implement this method to return a pointer to a copy of the object. Please don't forget to call Initialize() during this function and copy all of your settings.

Protected Member Functions inherited from QmitkNDIAbstractDeviceWidget
void	InitializeNDIWidget ()

Protected Member Functions inherited from QmitkAbstractTrackingDeviceWidget
PERSISTENCE_GET_SERVICE_METHOD_MACRO void	InitializeSuperclassWidget ()

Protected Attributes
Ui::QmitkNDIAuroraWidget *	m_Controls

Protected Attributes inherited from QmitkNDIAbstractDeviceWidget
QmitkTrackingDeviceConfigurationWidgetScanPortsWorker *	m_ScanPortsWorker

QThread *	m_ScanPortsWorkerThread

Protected Attributes inherited from QmitkAbstractTrackingDeviceWidget
QmitkTrackingDeviceConfigurationWidgetConnectionWorker *	m_TestConnectionWorker

QThread *	m_TestConnectionWorkerThread

Additional Inherited Members
Signals inherited from QmitkNDIAbstractDeviceWidget
void	PortsScanned (int Port, QString result, int PortType)

Signals inherited from QmitkAbstractTrackingDeviceWidget
void	ConnectionTested (bool connected, QString output)

Public Attributes inherited from QmitkAbstractTrackingDeviceWidget
std::string	m_ErrorMessage
	current problem description

Protected Slots inherited from QmitkNDIAbstractDeviceWidget
void	AutoScanPorts ()

void	AutoScanPortsFinished (int Port, QString result, int PortType)

Protected Slots inherited from QmitkAbstractTrackingDeviceWidget
void	TestConnectionFinished (bool connected, QString output)

void	TestConnection ()

Detailed Description

Implementation of a configuration widget for NDI Aurora Devices.

Documentation:

Definition at line 25 of file QmitkNDIAuroraWidget.h.

Constructor & Destructor Documentation

◆ QmitkNDIAuroraWidget()

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

Definition at line 23 of file QmitkNDIAuroraWidget.cpp.

◆ ~QmitkNDIAuroraWidget()

QmitkNDIAuroraWidget::~QmitkNDIAuroraWidget ( )

override

Definition at line 36 of file QmitkNDIAuroraWidget.cpp.

Member Function Documentation

◆ AddOutput()

void QmitkNDIAuroraWidget::AddOutput ( std::string )

overrideprotectedvirtual

Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget)

Implements QmitkNDIAbstractDeviceWidget.

Definition at line 73 of file QmitkNDIAuroraWidget.cpp.

◆ Clone()

QmitkNDIAuroraWidget * QmitkNDIAuroraWidget::Clone ( QWidget * parent ) const

overrideprotectedvirtual

Subclass must implement this method to return a pointer to a copy of the object. Please don't forget to call Initialize() during this function and copy all of your settings.

Implements QmitkAbstractTrackingDeviceWidget.

Definition at line 162 of file QmitkNDIAuroraWidget.cpp.

◆ GetTrackingDevice()

mitk::TrackingDevice::Pointer QmitkNDIAuroraWidget::GetTrackingDevice ( )

overrideprotectedvirtual

Implements QmitkAbstractTrackingDeviceWidget.

Definition at line 79 of file QmitkNDIAuroraWidget.cpp.

◆ Initialize()

void QmitkNDIAuroraWidget::Initialize ( )

overridevirtual

Subclass must implement this method to return a pointer to a copy of the object. Please don't forget to call InitializeSuperclassWidget(), CreateQtPartControl and optionally CreateConnections during this function.

Implements QmitkNDIAbstractDeviceWidget.

Definition at line 29 of file QmitkNDIAuroraWidget.cpp.

◆ LoadUISettings()

void QmitkNDIAuroraWidget::LoadUISettings ( )

overrideprotectedvirtual

Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget)

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Definition at line 124 of file QmitkNDIAuroraWidget.cpp.

◆ ResetOutput()

void QmitkNDIAuroraWidget::ResetOutput ( )

overrideprotectedvirtual

Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget)

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Definition at line 68 of file QmitkNDIAuroraWidget.cpp.

◆ SetPortTypeToGUI()

void QmitkNDIAuroraWidget::SetPortTypeToGUI ( int portType )

overrideprotectedvirtual

Implements QmitkNDIAbstractDeviceWidget.

Definition at line 158 of file QmitkNDIAuroraWidget.cpp.

◆ SetPortValueToGUI()

void QmitkNDIAuroraWidget::SetPortValueToGUI ( int portValue )

overrideprotectedvirtual

Implements QmitkNDIAbstractDeviceWidget.

Definition at line 155 of file QmitkNDIAuroraWidget.cpp.

◆ StoreUISettings()

void QmitkNDIAuroraWidget::StoreUISettings ( )

overrideprotectedvirtual

Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget)

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Definition at line 105 of file QmitkNDIAuroraWidget.cpp.

Member Data Documentation

◆ m_Controls

Ui::QmitkNDIAuroraWidget* QmitkNDIAuroraWidget::m_Controls

protected

Definition at line 55 of file QmitkNDIAuroraWidget.h.

◆ VIEW_ID

const std::string QmitkNDIAuroraWidget::VIEW_ID = "org.mitk.views.NDIAuroraWidget"

static

Definition at line 30 of file QmitkNDIAuroraWidget.h.

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

Modules/IGTUI/Qmitk/QmitkNDIAuroraWidget.h
Modules/IGTUI/Qmitk/QmitkNDIAuroraWidget.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QmitkNDIAuroraWidget()

◆ ~QmitkNDIAuroraWidget()

Member Function Documentation

◆ AddOutput()

◆ Clone()

◆ GetTrackingDevice()

◆ Initialize()

◆ LoadUISettings()

◆ ResetOutput()

◆ SetPortTypeToGUI()

◆ SetPortValueToGUI()

◆ StoreUISettings()

Member Data Documentation

◆ m_Controls

◆ VIEW_ID