cx::TrackingService Class Reference

Service providing tools and tracking systems. More...

#include <cxTrackingService.h>

Inheritance diagram for cx::TrackingService:

Public Types
typedef std::map< QString, ToolPtr >	ToolMap

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 void	clearActiveTool ()=0
	Deselect 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 std::vector< TrackerConfigurationPtr >	getConfigurations ()=0
virtual TrackerConfigurationPtr	getConfiguration ()=0
virtual void	setCurrentTrackingSystemImplementation (QString trackingSystemImplementation)=0
virtual QString	getCurrentTrackingSystemImplementation ()=0
virtual void	installTrackingSystem (TrackingSystemServicePtr system)=0
virtual void	unInstallTrackingSystem (TrackingSystemServicePtr system)=0
virtual std::vector< TrackingSystemServicePtr >	getTrackingSystems ()=0
virtual void	resetTimeSynchronization ()=0
	Reset time synchronization. Used for resetting time synchronization of incoming timestamps in OpenIGTLinkTrackingSystemService. More...
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

ToolMap

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

Definition at line 54 of file cxTrackingService.h.

Constructor & Destructor Documentation

~TrackingService()

virtual cx::TrackingService::~TrackingService ( )

inlinevirtual

Definition at line 56 of file cxTrackingService.h.

Member Function Documentation

activeToolChanged

void cx::TrackingService::activeToolChanged ( const QString &  uId )

signal

clearActiveTool()

virtual void cx::TrackingService::clearActiveTool ( )

pure virtual

Deselect active tool.

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

getActiveTool()

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.

getConfiguration()

virtual TrackerConfigurationPtr cx::TrackingService::getConfiguration ( )

pure virtual

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

getConfigurations()

virtual std::vector<TrackerConfigurationPtr> cx::TrackingService::getConfigurations ( )

pure virtual

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

getCurrentTrackingSystemImplementation()

virtual QString cx::TrackingService::getCurrentTrackingSystemImplementation ( )

pure virtual

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

getFirstProbe()

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.

getManualTool()

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.

getNullObject()

TrackingServicePtr cx::TrackingService::getNullObject ( )

static

Definition at line 18 of file cxTrackingService.cpp.

getReferenceTool()

virtual ToolPtr cx::TrackingService::getReferenceTool ( ) const

pure virtual

tool used as patient reference

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

getSessionHistory()

virtual SessionToolHistoryMap cx::TrackingService::getSessionHistory ( double  startTime, double  stopTime  )

pure virtual

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

getState()

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

pure virtual

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

getTool()

virtual ToolPtr cx::TrackingService::getTool ( const QString &  uid )

pure virtual

get a tool

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

getTools()

virtual ToolMap cx::TrackingService::getTools ( )

pure virtual

get configured and initialized tools

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

getTrackingSystems()

virtual std::vector<TrackingSystemServicePtr> cx::TrackingService::getTrackingSystems ( )

pure virtual

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

installTrackingSystem()

virtual void cx::TrackingService::installTrackingSystem ( TrackingSystemServicePtr  system )

pure virtual

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

isNull()

virtual bool cx::TrackingService::isNull ( )

pure virtual

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

isPlaybackMode()

virtual bool cx::TrackingService::isPlaybackMode ( ) const

pure virtual

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

resetTimeSynchronization()

virtual void cx::TrackingService::resetTimeSynchronization ( )

pure virtual

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

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

runDummyTool()

virtual void cx::TrackingService::runDummyTool ( DummyToolPtr  tool )

pure virtual

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

setActiveTool()

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.

setCurrentTrackingSystemImplementation()

virtual void cx::TrackingService::setCurrentTrackingSystemImplementation ( QString  trackingSystemImplementation )

pure virtual

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

setPlaybackMode()

virtual void cx::TrackingService::setPlaybackMode ( PlaybackTimePtr  controller )

pure virtual

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

setState()

virtual void cx::TrackingService::setState ( const Tool::State  val )

pure virtual

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

stateChanged

void cx::TrackingService::stateChanged ( )

signal

unInstallTrackingSystem()

virtual void cx::TrackingService::unInstallTrackingSystem ( TrackingSystemServicePtr  system )

pure virtual

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

---

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

• /mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-NI-BU2/CX/CX/source/resource/core/Tool/cxTrackingService.h
• /mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-NI-BU2/CX/CX/source/resource/core/Tool/cxTrackingService.cpp