mitk::NavigationToolReader Class Reference

This class offers methods to read objects of the class NavigationTool from the harddisc. The tools have to be saved in a special format by the class NavigationToolWriter to be loadable. More...

#include <mitkNavigationToolReader.h>

Inheritance diagram for mitk::NavigationToolReader:

Public Member Functions
	mitkClassMacroItkParent (NavigationToolReader, itk::Object)
	itkFactorylessNewMacro (Self)
	itkCloneMacro (Self)
mitk::NavigationTool::Pointer	DoRead (std::string filename)
	This method reads a navigation tool from a file.
	itkGetMacro (ErrorMessage, std::string)

Protected Member Functions
	NavigationToolReader ()
	~NavigationToolReader () override
mitk::NavigationTool::Pointer	ConvertDataNodeToNavigationTool (mitk::DataNode::Pointer node, std::string toolPath)
std::string	GetFileWithoutPath (std::string FileWithPath)
mitk::PointSet::Pointer	ConvertStringToPointSet (std::string string)
mitk::Point3D	ConvertStringToPoint (std::string string)
mitk::Quaternion	ConvertStringToQuaternion (std::string string)
void	split (std::string &text, std::string &separators, std::vector< std::string > &words)

Protected Attributes
std::string	m_ErrorMessage
std::string	m_ToolfilePath

Friends
class	mitk::NavigationToolStorageDeserializer

Detailed Description

This class offers methods to read objects of the class NavigationTool from the harddisc. The tools have to be saved in a special format by the class NavigationToolWriter to be loadable.

Documentation

Definition at line 34 of file mitkNavigationToolReader.h.

Constructor & Destructor Documentation

NavigationToolReader()

mitk::NavigationToolReader::NavigationToolReader ( )

protected

Definition at line 32 of file mitkNavigationToolReader.cpp.

~NavigationToolReader()

mitk::NavigationToolReader::~NavigationToolReader ( )

overrideprotected

Definition at line 37 of file mitkNavigationToolReader.cpp.

Member Function Documentation

ConvertDataNodeToNavigationTool()

mitk::NavigationTool::Pointer mitk::NavigationToolReader::ConvertDataNodeToNavigationTool ( mitk::DataNode::Pointer node, std::string toolPath )

protected

Definition at line 75 of file mitkNavigationToolReader.cpp.

ConvertStringToPoint()

mitk::Point3D mitk::NavigationToolReader::ConvertStringToPoint ( std::string string )

protected

Definition at line 229 of file mitkNavigationToolReader.cpp.

ConvertStringToPointSet()

mitk::PointSet::Pointer mitk::NavigationToolReader::ConvertStringToPointSet ( std::string string )

protected

Definition at line 206 of file mitkNavigationToolReader.cpp.

ConvertStringToQuaternion()

mitk::Quaternion mitk::NavigationToolReader::ConvertStringToQuaternion ( std::string string )

protected

Definition at line 244 of file mitkNavigationToolReader.cpp.

DoRead()

mitk::NavigationTool::Pointer mitk::NavigationToolReader::DoRead

(

std::string

filename

)

This method reads a navigation tool from a file.

Parameters

filename

The filename where the tool is stored, "C:\temp\myTool.igtTool" for example.

Returns

Returns a pointer to the tool which was read. Returns nullptr, if something went wrong and no tool was read. In this case you may also want the error message which is availiable from the method GetErrorMessage().

Definition at line 41 of file mitkNavigationToolReader.cpp.

GetFileWithoutPath()

std::string mitk::NavigationToolReader::GetFileWithoutPath ( std::string FileWithPath )

protected

Definition at line 200 of file mitkNavigationToolReader.cpp.

itkCloneMacro()

mitk::NavigationToolReader::itkCloneMacro

(

Self

)

itkFactorylessNewMacro()

mitk::NavigationToolReader::itkFactorylessNewMacro

(

Self

)

itkGetMacro()

mitk::NavigationToolReader::itkGetMacro	(	ErrorMessage	,
		std::string	)

mitkClassMacroItkParent()

mitk::NavigationToolReader::mitkClassMacroItkParent	(	NavigationToolReader	,
		itk::Object	)

split()

void mitk::NavigationToolReader::split ( std::string & text, std::string & separators, std::vector< std::string > & words )

protected

Definition at line 260 of file mitkNavigationToolReader.cpp.

Friends And Related Symbol Documentation

mitk::NavigationToolStorageDeserializer

friend class mitk::NavigationToolStorageDeserializer

friend

Definition at line 36 of file mitkNavigationToolReader.h.

Member Data Documentation

m_ErrorMessage

std::string mitk::NavigationToolReader::m_ErrorMessage

protected

Definition at line 57 of file mitkNavigationToolReader.h.

m_ToolfilePath

std::string mitk::NavigationToolReader::m_ToolfilePath

protected

Definition at line 59 of file mitkNavigationToolReader.h.

---

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

• Modules/IGT/IO/mitkNavigationToolReader.h
• Modules/IGT/IO/mitkNavigationToolReader.cpp