mitk::NavigationToolWriter Class Reference

This class offers methods to write objects of the class navigation tool permanently to the harddisk. The objects are saved in a special fileformat which can be read by the class NavigationToolReader to restore the object. More...

#include <mitkNavigationToolWriter.h>

Inheritance diagram for mitk::NavigationToolWriter:

Public Member Functions
	mitkClassMacroItkParent (NavigationToolWriter, itk::Object)
	itkFactorylessNewMacro (Self)
	itkCloneMacro (Self)
bool	DoWrite (std::string FileName, mitk::NavigationTool::Pointer Tool)
	Writes a navigation tool to a file.
	itkGetMacro (ErrorMessage, std::string)

Protected Member Functions
	NavigationToolWriter ()
	~NavigationToolWriter () override
mitk::DataNode::Pointer	ConvertToDataNode (mitk::NavigationTool::Pointer Tool)
std::string	GetFileWithoutPath (std::string FileWithPath)
std::string	ConvertPointSetToString (mitk::PointSet::Pointer pointSet)
std::string	ConvertPointToString (mitk::Point3D point)
std::string	ConvertQuaternionToString (mitk::Quaternion quat)

Protected Attributes
std::string	m_ErrorMessage

Friends
class	mitk::NavigationToolStorageSerializer

Detailed Description

This class offers methods to write objects of the class navigation tool permanently to the harddisk. The objects are saved in a special fileformat which can be read by the class NavigationToolReader to restore the object.

Documentation

Definition at line 35 of file mitkNavigationToolWriter.h.

Constructor & Destructor Documentation

NavigationToolWriter()

mitk::NavigationToolWriter::NavigationToolWriter ( )

protected

Definition at line 28 of file mitkNavigationToolWriter.cpp.

~NavigationToolWriter()

mitk::NavigationToolWriter::~NavigationToolWriter ( )

overrideprotected

Definition at line 33 of file mitkNavigationToolWriter.cpp.

Member Function Documentation

ConvertPointSetToString()

std::string mitk::NavigationToolWriter::ConvertPointSetToString ( mitk::PointSet::Pointer pointSet )

protected

Definition at line 141 of file mitkNavigationToolWriter.cpp.

ConvertPointToString()

std::string mitk::NavigationToolWriter::ConvertPointToString ( mitk::Point3D point )

protected

Definition at line 153 of file mitkNavigationToolWriter.cpp.

ConvertQuaternionToString()

std::string mitk::NavigationToolWriter::ConvertQuaternionToString ( mitk::Quaternion quat )

protected

Definition at line 160 of file mitkNavigationToolWriter.cpp.

ConvertToDataNode()

mitk::DataNode::Pointer mitk::NavigationToolWriter::ConvertToDataNode ( mitk::NavigationTool::Pointer Tool )

protected

Definition at line 98 of file mitkNavigationToolWriter.cpp.

DoWrite()

bool mitk::NavigationToolWriter::DoWrite	(	std::string	FileName,
		mitk::NavigationTool::Pointer	Tool )

Writes a navigation tool to a file.

Parameters

FileName	The filename (complete, with path, C:/temp/myTool.igtTool for example)
Tool	The tool which should be written to the file.

Returns

Returns true if the file was written successfully, false if not. In the second case you can get the error message by using the method GetErrorMessage().

Definition at line 38 of file mitkNavigationToolWriter.cpp.

GetFileWithoutPath()

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

protected

Definition at line 135 of file mitkNavigationToolWriter.cpp.

itkCloneMacro()

mitk::NavigationToolWriter::itkCloneMacro

(

Self

)

itkFactorylessNewMacro()

mitk::NavigationToolWriter::itkFactorylessNewMacro

(

Self

)

itkGetMacro()

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

mitkClassMacroItkParent()

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

Friends And Related Symbol Documentation

mitk::NavigationToolStorageSerializer

friend class mitk::NavigationToolStorageSerializer

friend

Definition at line 37 of file mitkNavigationToolWriter.h.

Member Data Documentation

m_ErrorMessage

std::string mitk::NavigationToolWriter::m_ErrorMessage

protected

Definition at line 58 of file mitkNavigationToolWriter.h.

---

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

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