Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
QmitkOpenIGTLinkWidget Class Reference

Implementation of a configuration widget to use an Open IGT Link connection to track any device. More...

#include <QmitkOpenIGTLinkWidget.h>

Inheritance diagram for QmitkOpenIGTLinkWidget:
Collaboration diagram for QmitkOpenIGTLinkWidget:

Public Member Functions

 QmitkOpenIGTLinkWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
 
 ~QmitkOpenIGTLinkWidget () 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...
 
mitk::TrackingDevice::Pointer GetTrackingDevice () 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 void ResetOutput ()
 Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget) More...
 
virtual void AddOutput (std::string)
 Optional method to add output to a small screen in the trackingToolbox (see QmitkNDIPolarisWidget) More...
 
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 Member Functions

QmitkOpenIGTLinkWidgetClone (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 QmitkAbstractTrackingDeviceWidget
PERSISTENCE_GET_SERVICE_METHOD_MACRO void InitializeSuperclassWidget ()
 

Protected Attributes

Ui::QmitkOpenIGTLinkWidget * m_Controls
 
- Protected Attributes inherited from QmitkAbstractTrackingDeviceWidget
QmitkTrackingDeviceConfigurationWidgetConnectionWorkerm_TestConnectionWorker
 
QThread * m_TestConnectionWorkerThread
 

Additional Inherited Members

- 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 QmitkAbstractTrackingDeviceWidget
void TestConnectionFinished (bool connected, QString output)
 
void TestConnection ()
 

Detailed Description

Implementation of a configuration widget to use an Open IGT Link connection to track any device.

Documentation:

Definition at line 25 of file QmitkOpenIGTLinkWidget.h.

Constructor & Destructor Documentation

◆ QmitkOpenIGTLinkWidget()

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

◆ ~QmitkOpenIGTLinkWidget()

QmitkOpenIGTLinkWidget::~QmitkOpenIGTLinkWidget ( )
override

Member Function Documentation

◆ Clone()

QmitkOpenIGTLinkWidget* QmitkOpenIGTLinkWidget::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.

◆ GetTrackingDevice()

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

◆ Initialize()

void QmitkOpenIGTLinkWidget::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 QmitkAbstractTrackingDeviceWidget.

Member Data Documentation

◆ m_Controls

Ui::QmitkOpenIGTLinkWidget* QmitkOpenIGTLinkWidget::m_Controls
protected

Definition at line 46 of file QmitkOpenIGTLinkWidget.h.

◆ VIEW_ID

const std::string QmitkOpenIGTLinkWidget::VIEW_ID
static

Definition at line 30 of file QmitkOpenIGTLinkWidget.h.


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