Medical Imaging Interaction Toolkit  2018.4.99-936b789b
Medical Imaging Interaction Toolkit
QmitkNDIPolarisWidget Class Reference

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

#include <QmitkNDIPolarisWidget.h>

Inheritance diagram for QmitkNDIPolarisWidget:
Collaboration diagram for QmitkNDIPolarisWidget:

Public Member Functions

 QmitkNDIPolarisWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
 
 ~QmitkNDIPolarisWidget () 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. More...
 
void ResetOutput () override
 Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget) More...
 
void AddOutput (std::string s) override
 Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget) More...
 
mitk::TrackingDevice::Pointer GetTrackingDevice () override
 
void StoreUISettings () override
 Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget) More...
 
void LoadUISettings () override
 Optional method to store and load settings of your widget (see QmitkNDIPolarisWidget) More...
 
- Public Member Functions inherited from QmitkNDIAbstractDeviceWidget
 QmitkNDIAbstractDeviceWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
 
 ~QmitkNDIAbstractDeviceWidget () override
 
- 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 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 QmitkNDIAbstractDeviceWidget
static const std::string VIEW_ID
 
- Static Public Attributes inherited from QmitkAbstractTrackingDeviceWidget
static const std::string VIEW_ID
 

Protected Member Functions

mitk::IlluminationActivationRate GetPolarisFrameRate ()
 
void SetPortValueToGUI (int portValue) override
 
void SetPortTypeToGUI (int portType) override
 
QmitkNDIPolarisWidgetClone (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. More...
 
- Protected Member Functions inherited from QmitkNDIAbstractDeviceWidget
void InitializeNDIWidget ()
 
- Protected Member Functions inherited from QmitkAbstractTrackingDeviceWidget
PERSISTENCE_GET_SERVICE_METHOD_MACRO void InitializeSuperclassWidget ()
 

Protected Attributes

Ui::QmitkNDIPolarisWidget * m_Controls
 
- Protected Attributes inherited from QmitkNDIAbstractDeviceWidget
QmitkTrackingDeviceConfigurationWidgetScanPortsWorkerm_ScanPortsWorker
 
QThread * m_ScanPortsWorkerThread
 
- Protected Attributes inherited from QmitkAbstractTrackingDeviceWidget
QmitkTrackingDeviceConfigurationWidgetConnectionWorkerm_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 More...
 
- 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 Polaris Devices.

Documentation:

Definition at line 25 of file QmitkNDIPolarisWidget.h.

Constructor & Destructor Documentation

◆ QmitkNDIPolarisWidget()

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

Definition at line 23 of file QmitkNDIPolarisWidget.cpp.

Referenced by Clone().

◆ ~QmitkNDIPolarisWidget()

QmitkNDIPolarisWidget::~QmitkNDIPolarisWidget ( )
override

Member Function Documentation

◆ AddOutput()

void QmitkNDIPolarisWidget::AddOutput ( std::string  )
overridevirtual

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

Implements QmitkNDIAbstractDeviceWidget.

Definition at line 75 of file QmitkNDIPolarisWidget.cpp.

References m_Controls.

◆ Clone()

QmitkNDIPolarisWidget * QmitkNDIPolarisWidget::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 184 of file QmitkNDIPolarisWidget.cpp.

References Initialize(), m_Controls, QmitkNDIPolarisWidget(), SetPortTypeToGUI(), and SetPortValueToGUI().

◆ GetPolarisFrameRate()

mitk::IlluminationActivationRate QmitkNDIPolarisWidget::GetPolarisFrameRate ( )
protected
Returns
Returns the frame rate set in the m_frameRatePolaris ComboBox

Definition at line 167 of file QmitkNDIPolarisWidget.cpp.

References mitk::Hz20, mitk::Hz30, mitk::Hz60, and m_Controls.

Referenced by GetTrackingDevice(), and StoreUISettings().

◆ GetTrackingDevice()

mitk::TrackingDevice::Pointer QmitkNDIPolarisWidget::GetTrackingDevice ( )
overridevirtual

◆ Initialize()

void QmitkNDIPolarisWidget::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 QmitkNDIPolarisWidget.cpp.

References QmitkNDIAbstractDeviceWidget::InitializeNDIWidget().

Referenced by Clone().

◆ LoadUISettings()

void QmitkNDIPolarisWidget::LoadUISettings ( )
overridevirtual

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

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Definition at line 130 of file QmitkNDIPolarisWidget.cpp.

References GetPersistenceService(), m_Controls, MITK_ERROR, SetPortTypeToGUI(), and SetPortValueToGUI().

◆ ResetOutput()

void QmitkNDIPolarisWidget::ResetOutput ( )
overridevirtual

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

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Definition at line 70 of file QmitkNDIPolarisWidget.cpp.

References m_Controls.

◆ SetPortTypeToGUI()

void QmitkNDIPolarisWidget::SetPortTypeToGUI ( int  portType)
overrideprotectedvirtual

Implements QmitkNDIAbstractDeviceWidget.

Definition at line 180 of file QmitkNDIPolarisWidget.cpp.

References m_Controls.

Referenced by Clone(), and LoadUISettings().

◆ SetPortValueToGUI()

void QmitkNDIPolarisWidget::SetPortValueToGUI ( int  portValue)
overrideprotectedvirtual

Implements QmitkNDIAbstractDeviceWidget.

Definition at line 177 of file QmitkNDIPolarisWidget.cpp.

References m_Controls.

Referenced by Clone(), and LoadUISettings().

◆ StoreUISettings()

void QmitkNDIPolarisWidget::StoreUISettings ( )
overridevirtual

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

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Definition at line 109 of file QmitkNDIPolarisWidget.cpp.

References GetPersistenceService(), GetPolarisFrameRate(), and m_Controls.

Member Data Documentation

◆ m_Controls

Ui::QmitkNDIPolarisWidget* QmitkNDIPolarisWidget::m_Controls
protected

◆ VIEW_ID

const std::string QmitkNDIPolarisWidget::VIEW_ID
static

Definition at line 30 of file QmitkNDIPolarisWidget.h.


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