Medical Imaging Interaction Toolkit  2021.10.99-fd647480
Medical Imaging Interaction Toolkit
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:
Collaboration diagram for mitk::NavigationToolReader:

Public Member Functions

 mitkClassMacroItkParent (NavigationToolReader, itk::Object)
 
Pointer Clone () const
 
mitk::NavigationTool::Pointer DoRead (std::string filename)
 This method reads a navigation tool from a file. More...
 
virtual std::string GetErrorMessage ()
 

Static Public Member Functions

static Pointer New ()
 

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
 

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

◆ ~NavigationToolReader()

mitk::NavigationToolReader::~NavigationToolReader ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::NavigationToolReader::Clone ( ) const

◆ ConvertDataNodeToNavigationTool()

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

◆ ConvertStringToPoint()

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

◆ ConvertStringToPointSet()

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

◆ ConvertStringToQuaternion()

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

◆ DoRead()

mitk::NavigationTool::Pointer mitk::NavigationToolReader::DoRead ( std::string  filename)

This method reads a navigation tool from a file.

Parameters
filenameThe 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().

◆ GetErrorMessage()

virtual std::string mitk::NavigationToolReader::GetErrorMessage ( )
virtual

◆ GetFileWithoutPath()

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

◆ mitkClassMacroItkParent()

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

◆ New()

static Pointer mitk::NavigationToolReader::New ( )
static

◆ split()

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

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 file: