Medical Imaging Interaction Toolkit  2016.11.0
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=0, Qt::WindowFlags f=0)
 
 ~QmitkNDIAbstractDeviceWidget ()
 
virtual void Initialize ()=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...
 
virtual void AddOutput (std::string s)=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=0, Qt::WindowFlags f=0)
 
virtual ~QmitkAbstractTrackingDeviceWidget ()
 
QmitkAbstractTrackingDeviceWidgetCloneForQt (QWidget *parent=0) 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 ConstructTrackingDevice ()=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...
 

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=0) 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

QThread * m_ScanPortsWorkerThread
 
QmitkTrackingDeviceConfigurationWidgetScanPortsWorkerm_ScanPortsWorker
 
- 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 30 of file QmitkNDIAbstractDeviceWidget.h.

Constructor & Destructor Documentation

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

Definition at line 23 of file QmitkNDIAbstractDeviceWidget.cpp.

QmitkNDIAbstractDeviceWidget::~QmitkNDIAbstractDeviceWidget ( )

Definition at line 36 of file QmitkNDIAbstractDeviceWidget.cpp.

References m_ScanPortsWorker, and m_ScanPortsWorkerThread.

Member Function Documentation

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

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

Reimplemented from QmitkAbstractTrackingDeviceWidget.

Implemented in QmitkNDIPolarisWidget, and QmitkNDIAuroraWidget.

Referenced by AutoScanPorts(), and AutoScanPortsFinished().

void QmitkNDIAbstractDeviceWidget::AutoScanPorts ( )
protectedslot

Definition at line 49 of file QmitkNDIAbstractDeviceWidget.cpp.

References AddOutput(), and m_ScanPortsWorkerThread.

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

This slot is called when the port scanning is finished.

Definition at line 56 of file QmitkNDIAbstractDeviceWidget.cpp.

References AddOutput(), m_ScanPortsWorkerThread, MITK_WARN, SetPortTypeToGUI(), and SetPortValueToGUI().

virtual void QmitkNDIAbstractDeviceWidget::Initialize ( )
pure 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.

void QmitkNDIAbstractDeviceWidget::InitializeNDIWidget ( )
protected
void QmitkNDIAbstractDeviceWidget::PortsScanned ( int  Port,
QString  result,
int  PortType 
)
signal
virtual void QmitkNDIAbstractDeviceWidget::SetPortTypeToGUI ( int  portType)
protectedpure virtual
virtual void QmitkNDIAbstractDeviceWidget::SetPortValueToGUI ( int  portValue)
protectedpure virtual

Member Data Documentation

QmitkTrackingDeviceConfigurationWidgetScanPortsWorker* QmitkNDIAbstractDeviceWidget::m_ScanPortsWorker
protected

Definition at line 64 of file QmitkNDIAbstractDeviceWidget.h.

Referenced by ~QmitkNDIAbstractDeviceWidget().

QThread* QmitkNDIAbstractDeviceWidget::m_ScanPortsWorkerThread
protected
const std::string QmitkNDIAbstractDeviceWidget::VIEW_ID
static

Definition at line 35 of file QmitkNDIAbstractDeviceWidget.h.


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