CustusX  2021.04.22-dev+develop.337f9
An IGT application
cx::TrackingService Class Referenceabstract

Service providing tools and tracking systems. More...

#include <cxTrackingService.h>

Inheritance diagram for cx::TrackingService:
cx::DummyToolManager cx::TrackingImplService cx::TrackingServiceNull cx::TrackingServiceProxy

Public Types

typedef std::map< QString, ToolPtrToolMap
 

Signals

void stateChanged ()
 
void activeToolChanged (const QString &uId)
 

Public Member Functions

virtual ~TrackingService ()
 
virtual Tool::State getState () const =0
 
virtual void setState (const Tool::State val)=0
 
virtual ToolPtr getTool (const QString &uid)=0
 get a tool More...
 
virtual ToolPtr getActiveTool ()=0
 get the tool that has higest priority when tracking More...
 
virtual void setActiveTool (const QString &uid)=0
 set a tool to be the active tool More...
 
virtual ToolPtr getFirstProbe ()=0
 get the active probe or any if none active More...
 
virtual ToolPtr getReferenceTool () const =0
 tool used as patient reference More...
 
virtual ToolPtr getManualTool ()=0
 a mouse-controllable virtual tool that is available even when not tracking. More...
 
virtual ToolMap getTools ()=0
 get configured and initialized tools More...
 
virtual bool isPlaybackMode () const =0
 
virtual void setPlaybackMode (PlaybackTimePtr controller)=0
 
virtual SessionToolHistoryMap getSessionHistory (double startTime, double stopTime)=0
 
virtual void runDummyTool (DummyToolPtr tool)=0
 
virtual TrackerConfigurationPtr getConfiguration ()=0
 
virtual void installTrackingSystem (TrackingSystemServicePtr system)=0
 
virtual void unInstallTrackingSystem (TrackingSystemServicePtr system)=0
 
virtual std::vector< TrackingSystemServicePtrgetTrackingSystems ()=0
 
virtual bool isNull ()=0
 

Static Public Member Functions

static TrackingServicePtr getNullObject ()
 

Detailed Description

Service providing tools and tracking systems.

Links the navigation system to the physical world. Devices with a physical position are realized by tracking hardware.

Definition at line 49 of file cxTrackingService.h.

Member Typedef Documentation

typedef std::map<QString, ToolPtr> cx::TrackingService::ToolMap

Definition at line 54 of file cxTrackingService.h.

Constructor & Destructor Documentation

virtual cx::TrackingService::~TrackingService ( )
inlinevirtual

Definition at line 56 of file cxTrackingService.h.

Member Function Documentation

void cx::TrackingService::activeToolChanged ( const QString &  uId)
signal
virtual ToolPtr cx::TrackingService::getActiveTool ( )
pure virtual

get the tool that has higest priority when tracking

Implemented in cx::TrackingImplService, cx::DummyToolManager, cx::TrackingServiceProxy, and cx::TrackingServiceNull.

virtual TrackerConfigurationPtr cx::TrackingService::getConfiguration ( )
pure virtual
virtual ToolPtr cx::TrackingService::getFirstProbe ( )
pure virtual

get the active probe or any if none active

Implemented in cx::TrackingImplService, cx::DummyToolManager, cx::TrackingServiceProxy, and cx::TrackingServiceNull.

virtual ToolPtr cx::TrackingService::getManualTool ( )
pure virtual

a mouse-controllable virtual tool that is available even when not tracking.

Implemented in cx::TrackingImplService, cx::DummyToolManager, cx::TrackingServiceProxy, and cx::TrackingServiceNull.

TrackingServicePtr cx::TrackingService::getNullObject ( )
static

Definition at line 18 of file cxTrackingService.cpp.

virtual ToolPtr cx::TrackingService::getReferenceTool ( ) const
pure virtual
virtual SessionToolHistoryMap cx::TrackingService::getSessionHistory ( double  startTime,
double  stopTime 
)
pure virtual
virtual Tool::State cx::TrackingService::getState ( ) const
pure virtual
virtual ToolPtr cx::TrackingService::getTool ( const QString &  uid)
pure virtual
virtual ToolMap cx::TrackingService::getTools ( )
pure virtual

get configured and initialized tools

Implemented in cx::TrackingImplService, cx::DummyToolManager, cx::TrackingServiceProxy, and cx::TrackingServiceNull.

virtual std::vector<TrackingSystemServicePtr> cx::TrackingService::getTrackingSystems ( )
pure virtual
virtual void cx::TrackingService::installTrackingSystem ( TrackingSystemServicePtr  system)
pure virtual
virtual bool cx::TrackingService::isNull ( )
pure virtual
virtual bool cx::TrackingService::isPlaybackMode ( ) const
pure virtual
virtual void cx::TrackingService::runDummyTool ( DummyToolPtr  tool)
pure virtual
virtual void cx::TrackingService::setActiveTool ( const QString &  uid)
pure virtual

set a tool to be the active tool

Implemented in cx::TrackingImplService, cx::DummyToolManager, cx::TrackingServiceProxy, and cx::TrackingServiceNull.

virtual void cx::TrackingService::setPlaybackMode ( PlaybackTimePtr  controller)
pure virtual
virtual void cx::TrackingService::setState ( const Tool::State  val)
pure virtual
void cx::TrackingService::stateChanged ( )
signal
virtual void cx::TrackingService::unInstallTrackingSystem ( TrackingSystemServicePtr  system)
pure virtual

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