An object of this class represents a navigation tool in the view of the software. A few informations like an identifier, a toolname, a surface and a itk spatial object are stored in such an object. The classes NavigationToolReader and are availiable to write/read tools to/from the harddisc. If you need a collection of navigation tools the class NavigationToolStorage could be used. More...

#include <mitkNavigationTool.h>

Public Types
enum	NavigationToolType { Instrument, Fiducial, Skinmarker, Unknown }
typedef NavigationTool	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual NavigationToolType	GetType ()
virtual void	SetType (NavigationToolType _arg)
virtual std::string	GetIdentifier ()
virtual void	SetIdentifier (std::string _arg)
virtual mitk::DataNode::Pointer	GetDataNode ()
virtual void	SetDataNode (mitk::DataNode::Pointer _arg)
virtual itk::SpatialObject < 3 >::Pointer	GetSpatialObject ()
virtual void	SetSpatialObject (itk::SpatialObject< 3 >::Pointer _arg)
virtual mitk::TrackingTool::Pointer	GetTrackingTool ()
virtual void	SetTrackingTool (mitk::TrackingTool::Pointer _arg)
virtual std::string	GetCalibrationFile ()
virtual void	SetCalibrationFile (std::string _arg)
virtual std::string	GetSerialNumber ()
virtual void	SetSerialNumber (std::string _arg)
virtual mitk::TrackingDeviceType	GetTrackingDeviceType ()
virtual void	SetTrackingDeviceType (mitk::TrackingDeviceType _arg)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	NavigationTool ()
	~NavigationTool ()
Protected Attributes
std::string	m_Identifier
NavigationToolType	m_Type
mitk::DataNode::Pointer	m_DataNode
	This DataNode holds a toolname and a tool surface.
itk::SpatialObject< 3 >::Pointer	m_SpatialObject
	This member variable holds a mathamatical description of the tool.
mitk::TrackingTool::Pointer	m_TrackingTool
	This member variable holds a pointer to the corresponding tracking tool in the hardware.
std::string	m_CalibrationFile
	The path to the calibration file of the tool.
std::string	m_SerialNumber
	A unique serial number of the tool which is needed to identify the tool correctly. This is very important in case of the NDI Aurora System.
mitk::TrackingDeviceType	m_TrackingDeviceType
	This member holds the tracking device type of the tool.

Detailed Description

An object of this class represents a navigation tool in the view of the software. A few informations like an identifier, a toolname, a surface and a itk spatial object are stored in such an object. The classes NavigationToolReader and are availiable to write/read tools to/from the harddisc. If you need a collection of navigation tools the class NavigationToolStorage could be used.

Documentation

Definition at line 42 of file mitkNavigationTool.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::NavigationTool::ConstPointer

Definition at line 46 of file mitkNavigationTool.h.

typedef itk::SmartPointer<Self> mitk::NavigationTool::Pointer

Definition at line 46 of file mitkNavigationTool.h.

typedef NavigationTool mitk::NavigationTool::Self

Definition at line 46 of file mitkNavigationTool.h.

typedef itk::Object mitk::NavigationTool::Superclass

Definition at line 46 of file mitkNavigationTool.h.

Member Enumeration Documentation

enum mitk::NavigationTool::NavigationToolType

Enumerator:

Instrument
Fiducial
Skinmarker
Unknown

Definition at line 49 of file mitkNavigationTool.h.

{Instrument, Fiducial, Skinmarker, Unknown};

Constructor & Destructor Documentation

mitk::NavigationTool::NavigationTool ( ) [protected]

Definition at line 20 of file mitkNavigationTool.cpp.

References m_Identifier, m_TrackingDeviceType, m_Type, mitk::TrackingSystemNotSpecified, and Unknown.

  {
    m_Type = mitk::NavigationTool::Unknown;
    m_Identifier = "None";
    m_TrackingDeviceType = mitk::TrackingSystemNotSpecified;
  }

mitk::NavigationTool::~NavigationTool ( ) [protected]

Definition at line 27 of file mitkNavigationTool.cpp.

  {

  }

Member Function Documentation

virtual std::string mitk::NavigationTool::GetCalibrationFile ( ) [virtual]

virtual const char* mitk::NavigationTool::GetClassName ( ) const [virtual]

virtual mitk::DataNode::Pointer mitk::NavigationTool::GetDataNode ( ) [virtual]

virtual std::string mitk::NavigationTool::GetIdentifier ( ) [virtual]

virtual std::string mitk::NavigationTool::GetSerialNumber ( ) [virtual]

virtual itk::SpatialObject<3>::Pointer mitk::NavigationTool::GetSpatialObject ( ) [virtual]

virtual mitk::TrackingDeviceType mitk::NavigationTool::GetTrackingDeviceType ( ) [virtual]

virtual mitk::TrackingTool::Pointer mitk::NavigationTool::GetTrackingTool ( ) [virtual]

virtual NavigationToolType mitk::NavigationTool::GetType ( ) [virtual]

static Pointer mitk::NavigationTool::New ( ) [static]

Referenced by mitk::NavigationToolReader::ConvertDataNodeToNavigationTool(), QmitkNavigationToolManagementWidget::OnAddToolSave(), mitkNavigationToolStorageTestClass::TestAddAndDelete(), mitkNavigationToolStorageTestClass::TestAddAndDelete100Tools(), mitkNavigationToolTestClass::TestGetterAndSetter(), mitkNavigationToolStorageTestClass::TestGetTool(), mitkNavigationToolTestClass::TestInstantiation(), and mitkNavigationToolReaderAndWriterTestClass::TestWrite().

virtual void mitk::NavigationTool::SetCalibrationFile ( std::string _arg ) [virtual]

virtual void mitk::NavigationTool::SetDataNode ( mitk::DataNode::Pointer _arg ) [virtual]

virtual void mitk::NavigationTool::SetIdentifier ( std::string _arg ) [virtual]

virtual void mitk::NavigationTool::SetSerialNumber ( std::string _arg ) [virtual]

virtual void mitk::NavigationTool::SetSpatialObject ( itk::SpatialObject< 3 >::Pointer _arg ) [virtual]

virtual void mitk::NavigationTool::SetTrackingDeviceType ( mitk::TrackingDeviceType _arg ) [virtual]

virtual void mitk::NavigationTool::SetTrackingTool ( mitk::TrackingTool::Pointer _arg ) [virtual]

virtual void mitk::NavigationTool::SetType ( NavigationToolType _arg ) [virtual]

Member Data Documentation

std::string mitk::NavigationTool::m_CalibrationFile [protected]

The path to the calibration file of the tool.

Definition at line 93 of file mitkNavigationTool.h.

mitk::DataNode::Pointer mitk::NavigationTool::m_DataNode [protected]

This DataNode holds a toolname and a tool surface.

Definition at line 87 of file mitkNavigationTool.h.

std::string mitk::NavigationTool::m_Identifier [protected]

Definition at line 84 of file mitkNavigationTool.h.

Referenced by NavigationTool().

std::string mitk::NavigationTool::m_SerialNumber [protected]

A unique serial number of the tool which is needed to identify the tool correctly. This is very important in case of the NDI Aurora System.

Definition at line 96 of file mitkNavigationTool.h.

itk::SpatialObject<3>::Pointer mitk::NavigationTool::m_SpatialObject [protected]

This member variable holds a mathamatical description of the tool.

Definition at line 89 of file mitkNavigationTool.h.

mitk::TrackingDeviceType mitk::NavigationTool::m_TrackingDeviceType [protected]

This member holds the tracking device type of the tool.

Definition at line 98 of file mitkNavigationTool.h.

Referenced by NavigationTool().

mitk::TrackingTool::Pointer mitk::NavigationTool::m_TrackingTool [protected]

This member variable holds a pointer to the corresponding tracking tool in the hardware.

Definition at line 91 of file mitkNavigationTool.h.

NavigationToolType mitk::NavigationTool::m_Type [protected]

Definition at line 85 of file mitkNavigationTool.h.

Referenced by NavigationTool().

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

mitk::NavigationTool Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation