NorMIT-nav  22.09
An IGT application
Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
cx::TrackingSystemService Class Referenceabstract
Core » Tool

Tracking System Service. More...

#include <cxTrackingSystemService.h>

Inheritance diagram for cx::TrackingSystemService:
cx::OpenIGTLinkTrackingSystemService cx::TrackingSystemBronchoscopyService cx::TrackingSystemDummyService cx::TrackingSystemIGSTKService cx::TrackingSystemPlaybackService

Signals

void stateChanged ()
 Reset time synchronization. Used for resetting time synchronization of incoming timestamps in OpenIGTLinkTrackingSystemService. More...
 
void updateTrackingSystemImplementation (QString trackingSystemImplementation)
 

Public Member Functions

 TrackingSystemService ()
 
virtual ~TrackingSystemService ()
 
virtual QString getUid () const =0
 
virtual Tool::State getState () const
 
virtual void setState (const Tool::State val)=0
 asynchronously request a state. Wait for signal stateChanged() More...
 
virtual std::vector< ToolPtr > getTools ()=0
 
virtual TrackerConfigurationPtr getConfiguration ()=0
 
virtual ToolPtr getReference ()=0
 reference tool used by entire tracking service - NOTE: system fails if several TrackingSystemServices define this tool More...
 
virtual void setConfigurationFile (QString configurationFile)
 
virtual void setLoggingFolder (QString loggingFolder)
 
virtual void resetTimeSynchronization ()
 

Protected Slots

virtual void initialize ()
 connects to the hardware More...
 
virtual void uninitialize ()
 disconnects from the hardware More...
 
virtual void startTracking ()
 starts tracking More...
 
virtual void stopTracking ()
 stops tracking More...
 

Protected Member Functions

virtual bool isConfigured () const
 
virtual bool isInitialized () const
 
virtual bool isTracking () const
 
void internalSetState (Tool::State val)
 

Protected Attributes

Tool::State mState
 
QString mConfigurationFilePath
 path to the configuration file More...
 
QString mLoggingFolder
 path to where logging should be saved More...
 

Detailed Description

Tracking System Service.

Represents one tracking system consisting of a collection of tools. Several such may exist.

Date
2014-09-30
Author
Christian Askeland, SINTEF

Definition at line 35 of file cxTrackingSystemService.h.

Constructor & Destructor Documentation

◆ TrackingSystemService()

cx::TrackingSystemService::TrackingSystemService ( )

Definition at line 17 of file cxTrackingSystemService.cpp.

◆ ~TrackingSystemService()

virtual cx::TrackingSystemService::~TrackingSystemService ( )
inlinevirtual

Definition at line 40 of file cxTrackingSystemService.h.

Member Function Documentation

◆ getConfiguration()

virtual TrackerConfigurationPtr cx::TrackingSystemService::getConfiguration ( )
pure virtual

Implemented in cx::TrackingSystemBronchoscopyService, cx::TrackingSystemIGSTKService, cx::TrackingSystemPlaybackService, cx::OpenIGTLinkTrackingSystemService, and cx::TrackingSystemDummyService.

◆ getReference()

virtual ToolPtr cx::TrackingSystemService::getReference ( )
pure virtual

reference tool used by entire tracking service - NOTE: system fails if several TrackingSystemServices define this tool

Implemented in cx::TrackingSystemBronchoscopyService, cx::TrackingSystemIGSTKService, cx::OpenIGTLinkTrackingSystemService, cx::TrackingSystemPlaybackService, and cx::TrackingSystemDummyService.

◆ getState()

Tool::State cx::TrackingSystemService::getState ( ) const
virtual

Reimplemented in cx::TrackingSystemBronchoscopyService, cx::TrackingSystemPlaybackService, and cx::TrackingSystemDummyService.

Definition at line 24 of file cxTrackingSystemService.cpp.

◆ getTools()

virtual std::vector<ToolPtr> cx::TrackingSystemService::getTools ( )
pure virtual

Implemented in cx::TrackingSystemBronchoscopyService, cx::TrackingSystemIGSTKService, cx::OpenIGTLinkTrackingSystemService, cx::TrackingSystemPlaybackService, and cx::TrackingSystemDummyService.

◆ getUid()

virtual QString cx::TrackingSystemService::getUid ( ) const
pure virtual

Implemented in cx::TrackingSystemBronchoscopyService, cx::TrackingSystemIGSTKService, cx::OpenIGTLinkTrackingSystemService, cx::TrackingSystemPlaybackService, and cx::TrackingSystemDummyService.

◆ initialize

void cx::TrackingSystemService::initialize ( )
protectedvirtualslot

connects to the hardware

Definition at line 95 of file cxTrackingSystemService.cpp.

◆ internalSetState()

void cx::TrackingSystemService::internalSetState ( Tool::State  val)
protected

Definition at line 70 of file cxTrackingSystemService.cpp.

◆ isConfigured()

bool cx::TrackingSystemService::isConfigured ( ) const
protectedvirtual

Definition at line 29 of file cxTrackingSystemService.cpp.

◆ isInitialized()

bool cx::TrackingSystemService::isInitialized ( ) const
protectedvirtual

Definition at line 34 of file cxTrackingSystemService.cpp.

◆ isTracking()

bool cx::TrackingSystemService::isTracking ( ) const
protectedvirtual

Definition at line 39 of file cxTrackingSystemService.cpp.

◆ resetTimeSynchronization()

virtual void cx::TrackingSystemService::resetTimeSynchronization ( )
inlinevirtual

Reimplemented in cx::OpenIGTLinkTrackingSystemService.

Definition at line 52 of file cxTrackingSystemService.h.

◆ setConfigurationFile()

void cx::TrackingSystemService::setConfigurationFile ( QString  configurationFile)
virtual

Definition at line 44 of file cxTrackingSystemService.cpp.

◆ setLoggingFolder()

void cx::TrackingSystemService::setLoggingFolder ( QString  loggingFolder)
virtual
Parameters
loggingFolderpath to the folder where logs should be saved

Reimplemented in cx::TrackingSystemBronchoscopyService, cx::TrackingSystemIGSTKService, cx::TrackingSystemPlaybackService, and cx::TrackingSystemDummyService.

Definition at line 57 of file cxTrackingSystemService.cpp.

◆ setState()

virtual void cx::TrackingSystemService::setState ( const Tool::State  val)
pure virtual

asynchronously request a state. Wait for signal stateChanged()

Implemented in cx::TrackingSystemBronchoscopyService, cx::TrackingSystemIGSTKService, cx::TrackingSystemPlaybackService, cx::OpenIGTLinkTrackingSystemService, and cx::TrackingSystemDummyService.

◆ startTracking

void cx::TrackingSystemService::startTracking ( )
protectedvirtualslot

starts tracking

Definition at line 104 of file cxTrackingSystemService.cpp.

◆ stateChanged

void cx::TrackingSystemService::stateChanged ( )
signal

Reset time synchronization. Used for resetting time synchronization of incoming timestamps in OpenIGTLinkTrackingSystemService.

◆ stopTracking

void cx::TrackingSystemService::stopTracking ( )
protectedvirtualslot

stops tracking

Definition at line 110 of file cxTrackingSystemService.cpp.

◆ uninitialize

void cx::TrackingSystemService::uninitialize ( )
protectedvirtualslot

disconnects from the hardware

Definition at line 101 of file cxTrackingSystemService.cpp.

◆ updateTrackingSystemImplementation

void cx::TrackingSystemService::updateTrackingSystemImplementation ( QString  trackingSystemImplementation)
signal

Member Data Documentation

◆ mConfigurationFilePath

QString cx::TrackingSystemService::mConfigurationFilePath
protected

path to the configuration file

Definition at line 68 of file cxTrackingSystemService.h.

◆ mLoggingFolder

QString cx::TrackingSystemService::mLoggingFolder
protected

path to where logging should be saved

Definition at line 69 of file cxTrackingSystemService.h.

◆ mState

Tool::State cx::TrackingSystemService::mState
protected

Definition at line 67 of file cxTrackingSystemService.h.

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