Class representing the tools a navigation system can recognize. More...

#include <cxOpenIGTLinkTool.h>

Inheritance diagram for cx::OpenIGTLinkTool:

Public Member Functions
	OpenIGTLinkTool (ConfigurationFileParser::ToolStructure configFileToolStructure, ToolFileParser::ToolInternalStructurePtr toolFileToolStructure)

virtual	~OpenIGTLinkTool ()

virtual bool	getVisible () const

virtual bool	isInitialized () const

virtual QString	getUid () const

virtual QString	getName () const

virtual ProbePtr	getProbe () const
	additional information if the tool represents an US Probe. Extends getProbeSector() More...

virtual double	getTimestamp () const
	latest valid timestamp for the position matrix. 0 means indeterminate (for f.ex. manual tools) More...

virtual double	getTooltipOffset () const
	get a virtual offset extending from the tool tip. More...

virtual void	setTooltipOffset (double val)
	set a virtual offset extending from the tool tip. More...

virtual bool	isCalibrated () const
	true if calibration is different from identity More...

virtual Transform3D	getCalibration_sMt () const
	get the calibration transform from tool space to sensor space (where the spheres or similar live) More...

virtual void	setCalibration_sMt (Transform3D sMt)
	requests to use the calibration and replaces the tools calibration file More...

virtual void	setVisible (bool vis)
	if available for this type, set visibility More...

bool	doIdCorrespondToTool (QString openIGTLinkId)

bool	isReference ()

bool	applyReference ()

Public Member Functions inherited from cx::ToolImpl
	ToolImpl (const QString &uid="", const QString &name="")

virtual	~ToolImpl ()

virtual TimedTransformMapPtr	getPositionHistory ()
	get historical positions More...

virtual TimedTransformMap	getSessionHistory (double startTime, double stopTime)

virtual Transform3D	get_prMt () const

virtual ToolPtr	getBaseTool ()

virtual ToolPositionMetadata	getMetadata () const

virtual const std::map< double, ToolPositionMetadata > &	getMetadataHistory ()

virtual void	resetTrackingPositionFilter (TrackingPositionFilterPtr filter)

virtual bool	isNull ()

virtual void	addXml (QDomNode &dataNode)

virtual void	parseXml (QDomNode &dataNode)

virtual vtkPolyDataPtr	getGraphicsPolyData () const
	get geometric 3D description More...

virtual bool	hasReferencePointWithId (QString id)

Public Member Functions inherited from cx::Tool
	Tool (const QString &uid="", const QString &name="")

virtual	~Tool ()

virtual bool	hasType (Type type) const

virtual void	printSelf (std::ostream &os, Indent indent)
	dump internal debug data More...

Protected Member Functions
virtual ToolFileParser::ToolInternalStructurePtr	getToolFileToolStructure () const

Protected Member Functions inherited from cx::ToolImpl
virtual void	set_prMt (const Transform3D &prMt, double timestamp)
	if available for this type, set pos, ts<0 means use current time More...

void	createToolGraphic ()

virtual std::set< Type >	getTypes () const

virtual std::map< QString, Vector3D >	getReferencePoints () const
	Get the optional reference points from this tool. More...

Friends
class	OpenIGTLinkTrackingSystemService

Additional Inherited Members
Public Types inherited from cx::Tool
enum	State { tsNONE =0, tsCONFIGURED, tsINITIALIZED, tsTRACKING }

enum	Type { TOOL_NONE, TOOL_REFERENCE, TOOL_MANUAL, TOOL_POINTER, TOOL_US_PROBE, TOOL_MICROSCOPE }

Signals inherited from cx::Tool
void	toolTransformAndTimestamp (Transform3D matrix, double timestamp)

void	toolVisible (bool visible)

void	tooltipOffset (double offset)

void	toolProbeSector ()

void	tps (int)

Static Public Member Functions inherited from cx::Tool
static vtkPolyDataPtr	createDefaultPolyDataCone ()

static ToolPtr	getNullObject ()

Protected Attributes inherited from cx::ToolImpl
TimedTransformMapPtr	mPositionHistory

Transform3D	m_prMt
	the transform from the tool to the patient reference More...

TrackingPositionFilterPtr	mTrackingPositionFilter

std::map< double, ToolPositionMetadata >	mMetadata

vtkPolyDataPtr	mPolyData
	the polydata used to represent the tool graphically More...

Protected Attributes inherited from cx::Tool
QString	mUid

QString	mName

Detailed Description

Class representing the tools a navigation system can recognize.

Date: 03 March 2015

Author: Janne Beate Bakeng, SINTEF

Definition at line 52 of file cxOpenIGTLinkTool.h.

Constructor & Destructor Documentation

cx::OpenIGTLinkTool::OpenIGTLinkTool	(	ConfigurationFileParser::ToolStructure	configFileToolStructure,
		ToolFileParser::ToolInternalStructurePtr	toolFileToolStructure
	)

Definition at line 22 of file cxOpenIGTLinkTool.cpp.

cx::OpenIGTLinkTool::~OpenIGTLinkTool ( )

virtual

Definition at line 64 of file cxOpenIGTLinkTool.cpp.

Member Function Documentation

bool cx::OpenIGTLinkTool::applyReference ( )

Definition at line 165 of file cxOpenIGTLinkTool.cpp.

bool cx::OpenIGTLinkTool::doIdCorrespondToTool ( QString openIGTLinkId )

Definition at line 54 of file cxOpenIGTLinkTool.cpp.

Transform3D cx::OpenIGTLinkTool::getCalibration_sMt ( ) const

virtual

get the calibration transform from tool space to sensor space (where the spheres or similar live)

Implements cx::Tool.

Definition at line 123 of file cxOpenIGTLinkTool.cpp.

QString cx::OpenIGTLinkTool::getName ( ) const

virtual

Returns: a descriptive name for this instance

Implements cx::Tool.

Definition at line 94 of file cxOpenIGTLinkTool.cpp.

ProbePtr cx::OpenIGTLinkTool::getProbe ( ) const

virtual

additional information if the tool represents an US Probe. Extends getProbeSector()

Reimplemented from cx::Tool.

Definition at line 68 of file cxOpenIGTLinkTool.cpp.

double cx::OpenIGTLinkTool::getTimestamp ( ) const

virtual

latest valid timestamp for the position matrix. 0 means indeterminate (for f.ex. manual tools)

Implements cx::Tool.

Definition at line 73 of file cxOpenIGTLinkTool.cpp.

ToolFileParser::ToolInternalStructurePtr cx::OpenIGTLinkTool::getToolFileToolStructure ( ) const

protectedvirtual

Reimplemented from cx::ToolImpl.

Definition at line 245 of file cxOpenIGTLinkTool.cpp.

double cx::OpenIGTLinkTool::getTooltipOffset ( ) const

virtual

get a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 99 of file cxOpenIGTLinkTool.cpp.

QString cx::OpenIGTLinkTool::getUid ( ) const

virtual

Returns: an unique id for this instance

Implements cx::Tool.

Definition at line 89 of file cxOpenIGTLinkTool.cpp.

bool cx::OpenIGTLinkTool::getVisible ( ) const

virtual

Returns: the visibility status of the tool

Implements cx::Tool.

Definition at line 78 of file cxOpenIGTLinkTool.cpp.

bool cx::OpenIGTLinkTool::isCalibrated ( ) const

virtual

true if calibration is different from identity

Implements cx::Tool.

Definition at line 113 of file cxOpenIGTLinkTool.cpp.

bool cx::OpenIGTLinkTool::isInitialized ( ) const

virtual

Reimplemented from cx::Tool.

Definition at line 83 of file cxOpenIGTLinkTool.cpp.

bool cx::OpenIGTLinkTool::isReference ( )

Definition at line 250 of file cxOpenIGTLinkTool.cpp.

void cx::OpenIGTLinkTool::setCalibration_sMt ( Transform3D sMt )

virtual

requests to use the calibration and replaces the tools calibration file

Reimplemented from cx::Tool.

Definition at line 128 of file cxOpenIGTLinkTool.cpp.

void cx::OpenIGTLinkTool::setTooltipOffset ( double val )

virtual

set a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 106 of file cxOpenIGTLinkTool.cpp.

void cx::OpenIGTLinkTool::setVisible ( bool vis )

virtual

if available for this type, set visibility

Implements cx::Tool.

Definition at line 239 of file cxOpenIGTLinkTool.cpp.

Friends And Related Function Documentation

friend class OpenIGTLinkTrackingSystemService

friend

Definition at line 54 of file cxOpenIGTLinkTool.h.

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

/media/jenkins/bamboo/buildagent/xml-data/build-dir/CX-NI-JOB1/CX/CX/source/plugins/org.custusx.core.openigtlink3/trackingSystemService/cxOpenIGTLinkTool.h
/media/jenkins/bamboo/buildagent/xml-data/build-dir/CX-NI-JOB1/CX/CX/source/plugins/org.custusx.core.openigtlink3/trackingSystemService/cxOpenIGTLinkTool.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation