Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
QmitkNDIAbstractDeviceWidget Class Referenceabstract

Abstract class of a configuration widget for NDI Devices. For implementations see NDIAuroraWidget or NDIPolarisWidget. More...

#include <QmitkNDIAbstractDeviceWidget.h>

Inheritance diagram for QmitkNDIAbstractDeviceWidget:
Collaboration diagram for QmitkNDIAbstractDeviceWidget:

Signals

void PortsScanned (int Port, QString result, int PortType)
 
- Signals inherited from QmitkAbstractTrackingDeviceWidget
void ConnectionTested (bool connected, QString output)
 

Public Member Functions

 QmitkNDIAbstractDeviceWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
 
 ~QmitkNDIAbstractDeviceWidget () override
 
void Initialize () override=0
 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. More...
 
void AddOutput (std::string s) override=0
 Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget) More...
 
- Public Member Functions inherited from QmitkAbstractTrackingDeviceWidget
 QmitkAbstractTrackingDeviceWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
 
 ~QmitkAbstractTrackingDeviceWidget () override
 
QmitkAbstractTrackingDeviceWidgetCloneForQt (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. More...
 
bool IsInitialized () const
 
virtual void ResetOutput ()
 Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget) More...
 
virtual mitk::TrackingDevice::Pointer GetTrackingDevice ()=0
 
virtual void StoreUISettings ()
 Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget) More...
 
virtual void LoadUISettings ()
 Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget) More...
 
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) More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void OnToolStorageChanged ()
 This function is called, when anything in the ToolStorage changed, e.g. AddTool or EditTool. ServiceListener is connected in the QmitkMITKIGTTrackingToolboxView. More...
 

Static Public Attributes

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

Protected Slots

void AutoScanPorts ()
 
void AutoScanPortsFinished (int Port, QString result, int PortType)
 
- Protected Slots inherited from QmitkAbstractTrackingDeviceWidget
void TestConnectionFinished (bool connected, QString output)
 
void TestConnection ()
 

Protected Member Functions

void InitializeNDIWidget ()
 
virtual void SetPortValueToGUI (int portValue)=0
 
virtual void SetPortTypeToGUI (int portType)=0
 
- Protected Member Functions inherited from QmitkAbstractTrackingDeviceWidget
PERSISTENCE_GET_SERVICE_METHOD_MACRO void InitializeSuperclassWidget ()
 
virtual QmitkAbstractTrackingDeviceWidgetClone (QWidget *parent=nullptr) const =0
 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. More...
 

Protected Attributes

QmitkTrackingDeviceConfigurationWidgetScanPortsWorkerm_ScanPortsWorker
 
QThread * m_ScanPortsWorkerThread
 
- Protected Attributes inherited from QmitkAbstractTrackingDeviceWidget
QmitkTrackingDeviceConfigurationWidgetConnectionWorkerm_TestConnectionWorker
 
QThread * m_TestConnectionWorkerThread
 

Additional Inherited Members

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

Detailed Description

Abstract class of a configuration widget for NDI Devices. For implementations see NDIAuroraWidget or NDIPolarisWidget.

Documentation:

Definition at line 26 of file QmitkNDIAbstractDeviceWidget.h.

Constructor & Destructor Documentation

◆ QmitkNDIAbstractDeviceWidget()

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

◆ ~QmitkNDIAbstractDeviceWidget()

QmitkNDIAbstractDeviceWidget::~QmitkNDIAbstractDeviceWidget ( )
override

Member Function Documentation

◆ AddOutput()

void QmitkNDIAbstractDeviceWidget::AddOutput ( std::string  )
overridepure virtual

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

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Implemented in QmitkNDIPolarisWidget, and QmitkNDIAuroraWidget.

◆ AutoScanPorts

void QmitkNDIAbstractDeviceWidget::AutoScanPorts ( )
protectedslot

◆ AutoScanPortsFinished

void QmitkNDIAbstractDeviceWidget::AutoScanPortsFinished ( int  Port,
QString  result,
int  PortType 
)
protectedslot

This slot is called when the port scanning is finished.

◆ Initialize()

void QmitkNDIAbstractDeviceWidget::Initialize ( )
overridepure virtual

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

Implemented in QmitkNDIAuroraWidget, and QmitkNDIPolarisWidget.

◆ InitializeNDIWidget()

void QmitkNDIAbstractDeviceWidget::InitializeNDIWidget ( )
protected

◆ PortsScanned

void QmitkNDIAbstractDeviceWidget::PortsScanned ( int  Port,
QString  result,
int  PortType 
)
signal

◆ SetPortTypeToGUI()

virtual void QmitkNDIAbstractDeviceWidget::SetPortTypeToGUI ( int  portType)
protectedpure virtual

◆ SetPortValueToGUI()

virtual void QmitkNDIAbstractDeviceWidget::SetPortValueToGUI ( int  portValue)
protectedpure virtual

Member Data Documentation

◆ m_ScanPortsWorker

QmitkTrackingDeviceConfigurationWidgetScanPortsWorker* QmitkNDIAbstractDeviceWidget::m_ScanPortsWorker
protected

Definition at line 59 of file QmitkNDIAbstractDeviceWidget.h.

◆ m_ScanPortsWorkerThread

QThread* QmitkNDIAbstractDeviceWidget::m_ScanPortsWorkerThread
protected

Definition at line 60 of file QmitkNDIAbstractDeviceWidget.h.

◆ VIEW_ID

const std::string QmitkNDIAbstractDeviceWidget::VIEW_ID
static

Definition at line 31 of file QmitkNDIAbstractDeviceWidget.h.


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